org.schmant.task.xml.dom
Class DomParseXmlTask

java.lang.Object
  org.schmant.support.AbstractArgumentChecker
      org.schmant.task.stub.AbstractTask<T>
          org.schmant.task.stub.AbstractActionTask<T>
              org.schmant.task.template.xml.AbstractParseXmlTask<DomParseXmlTask>
                  org.schmant.task.xml.dom.DomParseXmlTask

All Implemented Interfaces:

Producer<Document>, TaskDependency, ActionTaskConfigurable<DomParseXmlTask>, ActionTaskSpec<DomParseXmlTask>, LoggingConfigurable<DomParseXmlTask>, SourceConfigurable<DomParseXmlTask>, SourceConfigured, Task, TaskRunnable, TaskSpecification<DomParseXmlTask>

public final class DomParseXmlTask
extends AbstractParseXmlTask<DomParseXmlTask>
implements Producer<Document>

See DomParseXmlTF.

Since:

0.5

Author:

Karl Gustafsson

Task_package:

org.schmant.task.base

Method Summary

void	copyProperties(DomParseXmlTask spec) Override the implementation from AbstractTask to copy the source properties.
Document	get() Returns the produced object, or null if nothing is produced yet.
Document	getDocument() Get the parsed document.
Document	getDocumentOrNull() Get the parsed document, returning null if it is not parsed.
protected Schema	interpretSchema(Object o) Interprets the supplied object into a Schema using the following algorithm: If the object is a Producer, run the generated object through this method. If the object is a Schema, return it.
protected void	runInternal(Report r) Subclasses implement this.
String	toString() Default implementation for tasks.
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.template.xml.AbstractParseXmlTask

getErrorHandler, getFeatures

Methods inherited from class org.schmant.task.stub.AbstractActionTask

addSource, addSources, clearSources, getRelativeToBase, getSource, getSources, isMoreThanOneSourceAllowed, isSourcesMandatory, setRelativeToBase, setSource, setSources

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, 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

Method Detail

getDocument

public Document getDocument()

Get the parsed document. This can only be called after the task has been run,

Returns:

The parsed document.

See Also:

getDocumentOrNull()

getDocumentOrNull

public Document getDocumentOrNull()

Get the parsed document, returning null if it is not parsed.

Returns:

The document, or null if it is not parsed.

get

public Document get()

Description copied from interface: Producer

Returns the produced object, or null if nothing is produced yet.

This method should be implemented thread-safe.

Specified by:

get in interface Producer<Document>

Returns:

The produced object.

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<DomParseXmlTask>

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.

interpretSchema

protected Schema interpretSchema(Object o)
                          throws TaskFailedException

Interprets the supplied object into a Schema using the following algorithm:

1. If the object is a Producer, run the generated object through this method.
2. If the object is a Schema, return it.

Parameters:

o - The object to interpret.

Returns:

A schema.

Throws:

TaskFailedException - If the object cannot be interpreted as a schema.

runInternal

protected void runInternal(Report r)

Description copied from class: AbstractTask

Subclasses implement this. The task is AbstractTask.validate(Report):d before this method is called, see AbstractTask.run().

Specified by:

runInternal in class AbstractTask<DomParseXmlTask>

Parameters:

r - The current thread's Report.

copyProperties

public void copyProperties(DomParseXmlTask 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<DomParseXmlTask>

Overrides:

copyProperties in class AbstractParseXmlTask<DomParseXmlTask>

Parameters:

spec - The specification to copy properties to.

toString

public String toString()

Description copied from class: AbstractTask

Default implementation for tasks. Task implementations may override this. It is used in the default log header that is written (level INFO) before a task is run.

This implementation just returns the class name.

Overrides:

toString in class AbstractActionTask<DomParseXmlTask>