VOTableUtil
Class Data

java.lang.Object
  |
  +--VOTableUtil.Data

All Implemented Interfaces:

java.io.Serializable, com.tbf.xml.Validateable, com.tbf.xml.XmlObject

public class Data

extends java.lang.Object

implements com.tbf.xml.XmlObject, com.tbf.xml.Validateable, java.io.Serializable

Data class.

See Also:

Serialized Form

Field Summary

protected Binary	_Binary
protected static com.tbf.xml.XmlValidator	_Binary_validator_
protected java.util.Vector	_doc_declared_namespaces_ Storage for namespaces declared in the input document.
protected Fits	_Fits
protected static com.tbf.xml.XmlValidator	_Fits_validator_
protected static com.tbf.xml.XmlNamespaceManager	_nsm_ The default XmlNamespaceManager for this class.
protected Tabledata	_Tabledata Declarations for the XML related fields.
protected static com.tbf.xml.XmlValidator	_Tabledata_validator_
protected java.util.Vector	_unexpected_xml_errors_ Storage for UNEXPECTED_XML errors.
protected static boolean	_validators_created This flag is used to used to check whether the validators have been created.
static java.lang.String	$BINARY Constant for "BINARY" node name.
static java.lang.String	$DATA Constant for "DATA" node name.
static java.lang.String	$FITS Constant for "FITS" node name.
static java.lang.String	$TABLEDATA Constant for "TABLEDATA" node name.

Constructor Summary

Data()
Default no args constructor.

Data(com.tbf.xml.XmlElement xml)
Creates and populates an instance from the provided parse tree.

Data(com.tbf.xml.XmlElement xml, com.tbf.xml.XmlObject parent)
Creates and populates an instance from the provided parse tree.

Method Summary

boolean	contentEquals(java.lang.String tag_name) Returns true if the tag name of the contents equals the specified tag name.
java.lang.Object	contents() Get the current contents of this choice.
protected static void	createValidators() Create the validators for this class.
void	fromXml(com.tbf.xml.XmlElement xml) Deprecated. will be removed in a future release. Use unmarshal(XmlElement).
java.util.Vector	get$DocumentNamespaces() Get the Vector holding the namespaces declared in the element that this instance was unmarshalled from.
com.tbf.xml.XmlNamespaceManager	get$NamespaceManager() Get the XmlNamespaceManager for this class.
com.tbf.xml.XmlObject	get$Parent() Get this object's parent object.
Binary	getBinary() Get the Binary property.
static java.lang.String	getClassXmlTagName() Gets the XML tag name for this class.
Fits	getFits() Get the Fits property.
Tabledata	getTabledata() Get the Tabledata property.
java.util.Vector	getValidationErrors() Checks each field on the object for validity and returns a Vector holding the validation errors.
java.util.Vector	getValidationErrors(boolean return_on_error) Checks each field on the object for validity and returns a Vector holding the validation errors.
java.util.Vector	getValidationErrors(boolean return_on_error, boolean traverse) Checks each field on the object for validity and returns a Vector holding the validation errors.
java.lang.String	getXmlTagName() Gets the XML tag name for this object.
boolean	hasContents() Returns true if this choice has content.
boolean	isBinary() Returns true if the selected item in this choice is the Binary property.
boolean	isFits() Returns true if the selected item in this choice is the Fits property.
boolean	isTabledata() Returns true if the selected item in this choice is the Tabledata property.
boolean	isValid() Checks this object to see if it will produce valid XML.
void	marshal(java.io.OutputStream stream) Writes this instance to a stream.
void	marshal(com.tbf.xml.XmlOutputStream out) Writes this instance to an XmlOutputStream.
protected com.tbf.xml.XmlAttributeList	marshalAttributes(com.tbf.xml.XmlAttributeList attrs) Get the XmlAttributeList for marshalling.
static boolean	matches(com.tbf.xml.XmlElement xml, com.tbf.xml.XmlObject parent) Checks the XML to see whether it matches the XML contents of this class.
void	removeContents() Clear the current contents of this choice.
void	set$Parent(com.tbf.xml.XmlObject parent) Set this object's parent object.
void	setBinary(Binary obj) Set the Binary property.
void	setFits(Fits obj) Set the Fits property.
void	setTabledata(Tabledata obj) Set the Tabledata property.
void	toXml(java.io.OutputStream stream) Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).
void	toXml(java.io.OutputStream stream, boolean embed_files) Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).
void	toXml(java.io.OutputStream stream, java.lang.String indent, boolean embed_files) Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).
static Data	unmarshal(java.io.InputStream in) This method unmarshals an XML document instance into an instance of this class.
void	unmarshal(com.tbf.xml.XmlElement xml) Populates this object with the values from the parsed XML.
protected void	unmarshalAttributes(com.tbf.xml.XmlElement xml) Unmarshal any attributes.

Methods inherited from class java.lang.Object

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

Field Detail

$FITS

public static final java.lang.String $FITS

Constant for "FITS" node name.

$DATA

public static final java.lang.String $DATA

Constant for "DATA" node name.

$TABLEDATA

public static final java.lang.String $TABLEDATA

Constant for "TABLEDATA" node name.

$BINARY

public static final java.lang.String $BINARY

Constant for "BINARY" node name.

_Tabledata

protected Tabledata _Tabledata

Declarations for the XML related fields.

_Binary

protected Binary _Binary

_Fits

protected Fits _Fits

_unexpected_xml_errors_

protected transient java.util.Vector _unexpected_xml_errors_

Storage for UNEXPECTED_XML errors.

_validators_created

protected static transient boolean _validators_created

This flag is used to used to check whether the validators have been created.

_Tabledata_validator_

protected static transient com.tbf.xml.XmlValidator _Tabledata_validator_

_Binary_validator_

protected static transient com.tbf.xml.XmlValidator _Binary_validator_

_Fits_validator_

protected static transient com.tbf.xml.XmlValidator _Fits_validator_

_nsm_

protected static com.tbf.xml.XmlNamespaceManager _nsm_

The default XmlNamespaceManager for this class.

Since:

2.5

_doc_declared_namespaces_

protected java.util.Vector _doc_declared_namespaces_

Storage for namespaces declared in the input document.

Since:

2.5

Constructor Detail

Data

public Data()

Default no args constructor.

Data

public Data(com.tbf.xml.XmlElement xml)

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

Data

public Data(com.tbf.xml.XmlElement xml,
            com.tbf.xml.XmlObject parent)

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

parent - the containibg XmlObject

Method Detail

contents

public java.lang.Object contents()

Get the current contents of this choice.

removeContents

public void removeContents()

Clear the current contents of this choice.

hasContents

public boolean hasContents()

Returns true if this choice has content.

contentEquals

public boolean contentEquals(java.lang.String tag_name)

Returns true if the tag name of the contents equals the specified tag name.

isTabledata

public boolean isTabledata()

Returns true if the selected item in this choice is the Tabledata property.

isBinary

public boolean isBinary()

Returns true if the selected item in this choice is the Binary property.

isFits

public boolean isFits()

Returns true if the selected item in this choice is the Fits property.

getTabledata

public Tabledata getTabledata()

Get the Tabledata property.

setTabledata

public void setTabledata(Tabledata obj)

Set the Tabledata property.

getBinary

public Binary getBinary()

Get the Binary property.

setBinary

public void setBinary(Binary obj)

Set the Binary property.

getFits

public Fits getFits()

Get the Fits property.

setFits

public void setFits(Fits obj)

Set the Fits property.

getXmlTagName

public java.lang.String getXmlTagName()

Gets the XML tag name for this object.

Specified by:

getXmlTagName in interface com.tbf.xml.XmlObject

getClassXmlTagName

public static java.lang.String getClassXmlTagName()

Gets the XML tag name for this class.

createValidators

protected static void createValidators()

Create the validators for this class.

isValid

public boolean isValid()

Checks this object to see if it will produce valid XML.

Specified by:

isValid in interface com.tbf.xml.XmlObject

getValidationErrors

public java.util.Vector getValidationErrors()

Checks each field on the object for validity and returns a Vector holding the validation errors.

Specified by:

getValidationErrors in interface com.tbf.xml.Validateable

getValidationErrors

public java.util.Vector getValidationErrors(boolean return_on_error)

Checks each field on the object for validity and returns a Vector holding the validation errors.

Specified by:

getValidationErrors in interface com.tbf.xml.Validateable

Returns:

a Vector containing the validation errors

getValidationErrors

public java.util.Vector getValidationErrors(boolean return_on_error,
                                            boolean traverse)

Checks each field on the object for validity and returns a Vector holding the validation errors.

Specified by:

getValidationErrors in interface com.tbf.xml.Validateable

Returns:

a Vector containing the validation errors

matches

public static boolean matches(com.tbf.xml.XmlElement xml,
                              com.tbf.xml.XmlObject parent)

Checks the XML to see whether it matches the XML contents of this class.

unmarshal

public static Data unmarshal(java.io.InputStream in)
                      throws java.lang.Exception

This method unmarshals an XML document instance into an instance of this class.

fromXml

public void fromXml(com.tbf.xml.XmlElement xml)

Deprecated. will be removed in a future release. Use unmarshal(XmlElement).

Populates this object with the values from the parsed XML.

Specified by:

fromXml in interface com.tbf.xml.XmlObject

unmarshal

public void unmarshal(com.tbf.xml.XmlElement xml)

Populates this object with the values from the parsed XML.

Specified by:

unmarshal in interface com.tbf.xml.XmlObject

Since:

2.5

unmarshalAttributes

protected void unmarshalAttributes(com.tbf.xml.XmlElement xml)

Unmarshal any attributes.

Parameters:

xml - the XmlElement holding the parsed XML

Since:

2.5

toXml

public void toXml(java.io.OutputStream stream)

Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).

Writes this instance to a stream.

Specified by:

toXml in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

toXml

public void toXml(java.io.OutputStream stream,
                  boolean embed_files)

Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).

Writes this instance to a stream.

Specified by:

toXml in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

embed_files - set to true to embed files in the XML

toXml

public void toXml(java.io.OutputStream stream,
                  java.lang.String indent,
                  boolean embed_files)

Deprecated. This method will be removed in a future release. Use marshal(XmlOutputStream) or marshal(OutputStream).

Writes this instance to a stream.

Specified by:

toXml in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

embed_files - set to true to embed files in the XML

marshal

public void marshal(java.io.OutputStream stream)

Writes this instance to a stream. If the OutputStream is not an instance of XmlOutputStream then a FormattedOutputStream will be created which wraps the OutputStream.

Specified by:

marshal in interface com.tbf.xml.XmlObject

Parameters:

stream - the OutputStream to write the XML object to

Since:

2.5

See Also:

marshal(XmlOutputStream)

marshal

public void marshal(com.tbf.xml.XmlOutputStream out)

Writes this instance to an XmlOutputStream.

Specified by:

marshal in interface com.tbf.xml.XmlObject

Parameters:

out - the XmlOutputStream to write the XML object to

Since:

2.5

See Also:

marshal(OutputStream)

marshalAttributes

protected com.tbf.xml.XmlAttributeList marshalAttributes(com.tbf.xml.XmlAttributeList attrs)

Get the XmlAttributeList for marshalling.

Parameters:

attrs - the currently populated XmlAttributeList.

Returns:

a populated XmlAttributeList

Since:

2.5

get$Parent

public com.tbf.xml.XmlObject get$Parent()

Get this object's parent object.

Specified by:

get$Parent in interface com.tbf.xml.XmlObject

set$Parent

public void set$Parent(com.tbf.xml.XmlObject parent)

Set this object's parent object.

Specified by:

set$Parent in interface com.tbf.xml.XmlObject

get$NamespaceManager

public com.tbf.xml.XmlNamespaceManager get$NamespaceManager()

Get the XmlNamespaceManager for this class. This will be null if no namespaces on this class or if namespace support is disabled during code generation.

Specified by:

get$NamespaceManager in interface com.tbf.xml.XmlObject

Since:

2.5

get$DocumentNamespaces

public java.util.Vector get$DocumentNamespaces()

Get the Vector holding the namespaces declared in the element that this instance was unmarshalled from.

Since:

2.5