org.schmant.task.xml.catalog
Class AbstractXmlCatalogActionTask<T extends AbstractXmlCatalogActionTask<T>>

java.lang.Object
  extended by org.schmant.support.AbstractArgumentChecker
      extended by org.schmant.task.stub.AbstractTask<T>
          extended by org.schmant.task.stub.AbstractActionTask<T>
              extended by org.schmant.task.xml.catalog.AbstractXmlCatalogActionTask<T>
All Implemented Interfaces:
TaskDependency, ActionTaskConfigurable<T>, ActionTaskSpec<T>, LoggingConfigurable<T>, SourceConfigurable<T>, SourceConfigured, Task, TaskRunnable, TaskSpecification<T>
Direct Known Subclasses:
AddSystemIdToCatalogTask, AddUriToCatalogTask

public abstract class AbstractXmlCatalogActionTask<T extends AbstractXmlCatalogActionTask<T>>
extends AbstractActionTask<T>

Abstract base class for XML catalog action tasks.

Since:
0.5
Author:
Karl Gustafsson
Task_package:
org.schmant.task.base

Constructor Summary
AbstractXmlCatalogActionTask()
           
 
Method Summary
 void copyProperties(T spec)
          Override the implementation from AbstractTask to copy the source properties.
protected  XmlCatalog<?> getXmlCatalog()
           
protected  Collection<String> validate(Report r)
          Override the method inherited from AbstractTask to give a validation error if no source is set (and AbstractActionTask.isSourcesMandatory() is true).
 
Methods inherited from class org.schmant.task.stub.AbstractActionTask
addSource, addSources, clearSources, getRelativeToBase, getSource, getSources, isMoreThanOneSourceAllowed, isSourcesMandatory, setRelativeToBase, setSource, setSources, toString
 
Methods inherited from class org.schmant.task.stub.AbstractTask
cancel, createTask, getDefaultLogFooter, getDefaultLogHeader, getDependencyForTasksScheduledByThisTask, getDependencyObservable, getFailureCause, getLogFooter, getLogHeader, getSatisfiedStateLock, getThis, isCancelled, isDone, isInterrupted, isRunning, isSatisfied, isSuccessful, run, runInternal, setLogFooter, setLogHeader, setReportLevel, setTraceLogging
 
Methods inherited from class org.schmant.support.AbstractArgumentChecker
check, check, check, check
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.schmant.task.TaskSpecification
createTask
 
Methods inherited from interface org.schmant.task.confable.LoggingConfigurable
setLogFooter, setLogHeader, setReportLevel, setTraceLogging
 

Constructor Detail

AbstractXmlCatalogActionTask

public AbstractXmlCatalogActionTask()
Method Detail

getXmlCatalog

protected final XmlCatalog<?> getXmlCatalog()

validate

protected Collection<String> validate(Report r)
Description copied from class: AbstractActionTask
Override the method inherited from AbstractTask to give a validation error if no source is set (and AbstractActionTask.isSourcesMandatory() is true).

Subclasses may override this to add their own validations.

Overrides:
validate in class AbstractActionTask<T extends AbstractXmlCatalogActionTask<T>>
Parameters:
r - A report to log warning and debug messages to. Validation errors should not be logged, though. They are logged later.
Returns:
A collection of error messages.

copyProperties

public void copyProperties(T spec)
Description copied from class: AbstractActionTask
Override the implementation from AbstractTask to copy the source properties. Subclasses must override this to copy their own properties.

Specified by:
copyProperties in interface TaskSpecification<T extends AbstractXmlCatalogActionTask<T>>
Overrides:
copyProperties in class AbstractActionTask<T extends AbstractXmlCatalogActionTask<T>>
Parameters:
spec - The specification to copy properties to.