PlaceholderComponentJob.java

/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.descriptors;

import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.Map;
import java.util.Set;

import org.datacleaner.api.AnalyzerResult;
import org.datacleaner.api.AnalyzerResultReducer;
import org.datacleaner.api.ComponentCategory;
import org.datacleaner.api.ComponentSuperCategory;
import org.datacleaner.api.Description;
import org.datacleaner.api.HasAnalyzerResult;
import org.datacleaner.api.InputColumn;
import org.datacleaner.job.ComponentConfiguration;
import org.datacleaner.job.ComponentJob;
import org.datacleaner.job.ComponentRequirement;
import org.datacleaner.job.OutputDataStreamJob;
import org.datacleaner.result.AnalysisResult;
import org.datacleaner.util.ReflectionUtils;
import org.datacleaner.util.StringUtils;

/**
 * A placeholder component job instance to put as a key when rendering
 * "unidentified" result objects, ie. result objects that are serialized outside
 * of a {@link AnalysisResult}
 */
public class PlaceholderComponentJob<C extends HasAnalyzerResult<?>>
        implements ComponentJob, ComponentDescriptor<C>, HasAnalyzerResultComponentDescriptor<C> {

    private static final long serialVersionUID = 1L;

    private final String _name;
    private final Class<C> _componentClass;
    private final ResultDescriptor _resultDescriptor;

    public PlaceholderComponentJob(final String name, final Class<C> componentClass,
            final Class<? extends AnalyzerResult> resultClass) {
        _name = name;
        _componentClass = componentClass;
        _resultDescriptor = new ResultDescriptorImpl(resultClass);
    }

    @Override
    public ComponentDescriptor<?> getDescriptor() {
        return this;
    }

    @Override
    public String getName() {
        return _name;
    }

    @Override
    public int compareTo(final ComponentDescriptor<?> o) {
        return -1;
    }

    @Override
    public String getDisplayName() {
        // this is the 'descriptor' name, e.g. will be used for CSS styling
        final Description desc = ReflectionUtils.getAnnotation(_componentClass, Description.class);
        if (desc == null || StringUtils.isNullOrEmpty(desc.value())) {
            return _componentClass.getSimpleName();
        }
        return desc.value();
    }

    @Override
    public C newInstance() {
        return null;
    }

    @Override
    public Class<C> getComponentClass() {
        return _componentClass;
    }

    @Override
    public Set<ConfiguredPropertyDescriptor> getConfiguredProperties() {
        return Collections.emptySet();
    }

    @Override
    public Set<ConfiguredPropertyDescriptor> getConfiguredPropertiesByAnnotation(
            final Class<? extends Annotation> annotation) {
        return Collections.emptySet();
    }

    @Override
    public Set<ConfiguredPropertyDescriptor> getConfiguredPropertiesByType(final Class<?> type,
            final boolean includeArrays) {
        return Collections.emptySet();
    }

    @Override
    public ConfiguredPropertyDescriptor getConfiguredProperty(final String name) {
        return null;
    }

    @Override
    public Set<ValidateMethodDescriptor> getValidateMethods() {
        return Collections.emptySet();
    }

    @Override
    public Set<InitializeMethodDescriptor> getInitializeMethods() {
        return Collections.emptySet();
    }

    @Override
    public Set<CloseMethodDescriptor> getCloseMethods() {
        return Collections.emptySet();
    }

    @Override
    public Set<ProvidedPropertyDescriptor> getProvidedProperties() {
        return Collections.emptySet();
    }

    @Override
    public Set<ProvidedPropertyDescriptor> getProvidedPropertiesByType(final Class<?> cls) {
        return Collections.emptySet();
    }

    @Override
    public Class<? extends AnalyzerResult> getResultClass() {
        return _resultDescriptor.getResultClass();
    }

    @Override
    public MetricDescriptor getResultMetric(final String name) {
        return _resultDescriptor.getResultMetric(name);
    }

    @Override
    public Set<MetricDescriptor> getResultMetrics() {
        return _resultDescriptor.getResultMetrics();
    }

    @Override
    public Class<? extends AnalyzerResultReducer<?>> getResultReducerClass() {
        return _resultDescriptor.getResultReducerClass();
    }

    @Override
    public String getDescription() {
        return null;
    }

    @Override
    public Set<ComponentCategory> getComponentCategories() {
        return Collections.emptySet();
    }

    @Override
    public Set<Annotation> getAnnotations() {
        return Collections.emptySet();
    }

    @Override
    public boolean isDistributable() {
        return false;
    }

    @Override
    public <A extends Annotation> A getAnnotation(final Class<A> annotationClass) {
        return null;
    }

    @Override
    public Set<ConfiguredPropertyDescriptor> getConfiguredPropertiesForInput() {
        return Collections.emptySet();
    }

    @Override
    public Set<ConfiguredPropertyDescriptor> getConfiguredPropertiesForInput(final boolean includeOptional) {
        return Collections.emptySet();
    }

    @Override
    public String[] getAliases() {
        return new String[0];
    }

    @Override
    public ComponentRequirement getComponentRequirement() {
        return null;
    }

    @Override
    public Map<String, String> getMetadataProperties() {
        return Collections.emptyMap();
    }

    @Override
    public InputColumn<?>[] getInput() {
        return new InputColumn[0];
    }

    @Override
    public ComponentConfiguration getConfiguration() {
        return null;
    }

    @Override
    public ComponentSuperCategory getComponentSuperCategory() {
        return null;
    }

    @Override
    public OutputDataStreamJob[] getOutputDataStreamJobs() {
        return new OutputDataStreamJob[0];
    }

    @Override
    public boolean isMultiStreamComponent() {
        return false;
    }
}