/**
* 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.job.runner;
import java.util.Queue;
import java.util.concurrent.LinkedBlockingQueue;
import org.datacleaner.api.Initialize;
import org.datacleaner.configuration.DataCleanerConfiguration;
import org.datacleaner.job.AnalysisJob;
import org.datacleaner.job.concurrent.TaskRunner;
/**
* Default implementation of the AnalysisRunner interface.
*
*
*/
public class AnalysisRunnerImpl implements AnalysisRunner {
private final DataCleanerConfiguration _configuration;
private final AnalysisListener[] _sharedAnalysisListeners;
/**
* Creates an AnalysisRunner based on a configuration, with no listeners
*
* @param configuration
*/
public AnalysisRunnerImpl(final DataCleanerConfiguration configuration) {
this(configuration, new AnalysisListener[0]);
}
/**
* Create an AnalysisRunner with a set of listeners, based on a
* configuration
*
* @param configuration
* @param sharedAnalysisListeners
*/
public AnalysisRunnerImpl(final DataCleanerConfiguration configuration,
final AnalysisListener... sharedAnalysisListeners) {
if (configuration == null) {
throw new IllegalArgumentException("configuration cannot be null");
}
_configuration = configuration;
_sharedAnalysisListeners = sharedAnalysisListeners;
}
@Override
public AnalysisResultFuture run(final AnalysisJob job) {
final Queue<JobAndResult> resultQueue = new LinkedBlockingQueue<>();
// This analysis listener will keep track of all collected errors
final ErrorAwareAnalysisListener errorListener = new ErrorAwareAnalysisListener();
// This analysis listener is a composite for all other listeners
final CompositeAnalysisListener analysisListener =
new CompositeAnalysisListener(errorListener, _sharedAnalysisListeners);
if (DebugLoggingAnalysisListener.isEnabled()) {
// enable debug logging?
analysisListener.addDelegate(new DebugLoggingAnalysisListener());
} else if (InfoLoggingAnalysisListener.isEnabled()) {
analysisListener.addDelegate(new InfoLoggingAnalysisListener());
}
// set up the task runner that is aware of errors
final TaskRunner taskRunner =
new ErrorAwareTaskRunnerWrapper(errorListener, _configuration.getEnvironment().getTaskRunner());
final boolean includedNonDistributed = isNonDistributedTasksIncluded();
// the delegate will do all the actual work
final AnalysisRunnerJobDelegate delegate =
new AnalysisRunnerJobDelegate(job, _configuration, taskRunner, analysisListener, resultQueue,
errorListener, includedNonDistributed);
return delegate.run();
}
/**
* Determines whether or not non-distributed methods (such as
* {@link Initialize} or {@link Cloneable} methods that are marked with
* distributed=false) should be included or not in the work executed. On
* single-node executions, this will typically be true, on slave nodes in a
* cluster, this will typically be false.
*
* @return
*/
protected boolean isNonDistributedTasksIncluded() {
return true;
}
}