uk.ac.starlink.ttools.task

Class VotCopy

java.lang.Object

uk.ac.starlink.ttools.task.VotCopy

All Implemented Interfaces:

Task

public class VotCopy
extends Object
implements Task

Task which Copies a VOTable XML document intact but with control over the DATA encoding type.

Since:

19 Apr 2005

Author:

Mark Taylor (Starlink)

Constructor Summary

Constructors

Constructor and Description
VotCopy() Constructor.

Method Summary

Modifier and Type	Method and Description
Executable	createExecutable(Environment env) Creates an executable object which will do the work of this task in the given Environment.
Parameter<?>[]	getParameters() Returns the list of parameters which may be used by this task.
String	getPurpose() Returns a short (one-line) description of the purpose of this task.
static void	saxCopy(InputSource saxSrc, VotCopyHandler copyHandler) Copies the SAX stream to the output, writing TABLE DATA elements in a given encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VotCopy

public VotCopy()

Constructor.

Method Detail

getPurpose

public String getPurpose()

Description copied from interface: Task

Returns a short (one-line) description of the purpose of this task.

Specified by:

getPurpose in interface Task

Returns:

plain text description of this task's purpose

getParameters

public Parameter<?>[] getParameters()

Description copied from interface: Task

Returns the list of parameters which may be used by this task.

Specified by:

getParameters in interface Task

Returns:

an array of the Parameter objects this task may request values for during its invocation

createExecutable

public Executable createExecutable(Environment env)
                            throws TaskException

Description copied from interface: Task

Creates an executable object which will do the work of this task in the given Environment. This method should do all of the parameter processing and prepare an object which just executes. The idea is that any communication with the user related to the supplied parameter values can be done before the task starts to execute in earnest. Consequently, the returned Executable object ought not to make any reference to env, though this is not absolutely prohibited.

Specified by:

createExecutable in interface Task

Parameters:

env - the environment in which the task will operate

Throws:

TaskException - if no executable can be created; this should usually be a UsageException or some subclass

saxCopy

public static void saxCopy(InputSource saxSrc,
                           VotCopyHandler copyHandler)
                    throws SAXException,
                           IOException

Copies the SAX stream to the output, writing TABLE DATA elements in a given encoding.

Parameters:

saxSrc - SAX input source

copyHandler - handler which can consume SAX events - may be a LexicalHandler too

Throws:

SAXException

IOException