VOTableUtil
Class Table

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

All Implemented Interfaces:

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

public class Table

extends java.lang.Object

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

Table class.

See Also:

Serialized Form

Field Summary

protected Data	_Data
protected static com.tbf.xml.XmlValidator	_Data_validator_
protected java.lang.String	_Description
protected java.util.Vector	_doc_declared_namespaces_ Storage for namespaces declared in the input document.
protected java.util.Vector	_Field
protected static com.tbf.xml.XmlValidator	_Field_validator_
protected java.lang.String	_Id Declarations for the XML related fields.
protected java.util.Vector	_Link
protected static com.tbf.xml.XmlValidator	_Link_validator_
protected java.lang.String	_Name
protected static com.tbf.xml.XmlNamespaceManager	_nsm_ The default XmlNamespaceManager for this class.
protected java.lang.String	_Ref
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	$DATA Constant for "DATA" node name.
static java.lang.String	$DESCRIPTION Constant for "DESCRIPTION" node name.
static java.lang.String	$FIELD Constant for "FIELD" node name.
static java.lang.String	$ID Constant for "ID" node name.
static java.lang.String	$LINK Constant for "LINK" node name.
static java.lang.String	$NAME Constant for "name" node name.
static java.lang.String	$REF Constant for "ref" node name.
static java.lang.String	$TABLE Constant for "TABLE" node name.

Constructor Summary

Table()
Default no args constructor.

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

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

Method Summary

void	addField(Field obj)
void	addLink(Link obj)
protected static void	createValidators() Create the validators for this class.
void	deleteData() Discards Data's value.
void	deleteDescription() Discards Description's value.
void	deleteId() Discards Id's value.
void	deleteName() Discards Name's value.
void	deleteRef() Discards Ref's value.
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.
static java.lang.String	getClassXmlTagName() Gets the XML tag name for this class.
Data	getData() Get the Data property.
java.lang.Object	getData$Contents() Get the content of the Data choice list.
java.lang.String	getDescription() Get the Description property.
java.util.Vector	getField() Get the Field property.
Field	getFieldAt(int index)
int	getFieldCount() Get the count of elements in the Field property.
java.lang.String	getId() Get the Id property.
java.util.Vector	getLink() Get the Link property.
Link	getLinkAt(int index)
int	getLinkCount() Get the count of elements in the Link property.
java.lang.String	getName() Get the Name property.
java.lang.String	getRef() Get the Ref 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	hasData() Checks for whether Data is set or not.
boolean	hasDescription() Checks for whether Description is set or not.
boolean	hasId() Checks for whether Id is set or not.
boolean	hasName() Checks for whether Name is set or not.
boolean	hasRef() Checks for whether Ref is set or not.
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	removeField(Field obj)
void	removeFieldAt(int index)
void	removeLink(Link obj)
void	removeLinkAt(int index)
void	set$Parent(com.tbf.xml.XmlObject parent) Set this object's parent object.
void	setData(Data obj) Set the Data property.
void	setDescription(java.lang.String newValue) Set the Description property.
void	setField(java.util.Vector newList) Set the Field property.
void	setFieldAt(Field obj, int index)
void	setId(java.lang.String newValue) Set the Id property.
void	setLink(java.util.Vector newList) Set the Link property.
void	setLinkAt(Link obj, int index)
void	setName(java.lang.String newValue) Set the Name property.
void	setRef(java.lang.String newValue) Set the Ref 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 Table	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

$LINK

public static final java.lang.String $LINK

Constant for "LINK" node name.

$ID

public static final java.lang.String $ID

Constant for "ID" node name.

$DATA

public static final java.lang.String $DATA

Constant for "DATA" node name.

$DESCRIPTION

public static final java.lang.String $DESCRIPTION

Constant for "DESCRIPTION" node name.

$NAME

public static final java.lang.String $NAME

Constant for "name" node name.

$REF

public static final java.lang.String $REF

Constant for "ref" node name.

$TABLE

public static final java.lang.String $TABLE

Constant for "TABLE" node name.

$FIELD

public static final java.lang.String $FIELD

Constant for "FIELD" node name.

_Id

protected java.lang.String _Id

Declarations for the XML related fields.

_Name

protected java.lang.String _Name

_Ref

protected java.lang.String _Ref

_Description

protected java.lang.String _Description

_Field

protected java.util.Vector _Field

_Link

protected java.util.Vector _Link

_Data

protected Data _Data

_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.

_Field_validator_

protected static transient com.tbf.xml.XmlValidator _Field_validator_

_Link_validator_

protected static transient com.tbf.xml.XmlValidator _Link_validator_

_Data_validator_

protected static transient com.tbf.xml.XmlValidator _Data_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

Table

public Table()

Default no args constructor.

Table

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

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

Table

public Table(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

getId

public java.lang.String getId()

Get the Id property.

setId

public void setId(java.lang.String newValue)

Set the Id property.

hasId

public boolean hasId()

Checks for whether Id is set or not.

Returns:

true if Id is set, false if not

deleteId

public void deleteId()

Discards Id's value.

getName

public java.lang.String getName()

Get the Name property.

setName

public void setName(java.lang.String newValue)

Set the Name property.

hasName

public boolean hasName()

Checks for whether Name is set or not.

Returns:

true if Name is set, false if not

deleteName

public void deleteName()

Discards Name's value.

getRef

public java.lang.String getRef()

Get the Ref property.

setRef

public void setRef(java.lang.String newValue)

Set the Ref property.

hasRef

public boolean hasRef()

Checks for whether Ref is set or not.

Returns:

true if Ref is set, false if not

deleteRef

public void deleteRef()

Discards Ref's value.

getDescription

public java.lang.String getDescription()

Get the Description property.

setDescription

public void setDescription(java.lang.String newValue)

Set the Description property.

hasDescription

public boolean hasDescription()

Checks for whether Description is set or not.

Returns:

true if Description is set, false if not

deleteDescription

public void deleteDescription()

Discards Description's value.

getField

public java.util.Vector getField()

Get the Field property.

getFieldAt

public Field getFieldAt(int index)
                 throws java.lang.IndexOutOfBoundsException

getFieldCount

public int getFieldCount()

Get the count of elements in the Field property.

setField

public void setField(java.util.Vector newList)

Set the Field property.

addField

public void addField(Field obj)

setFieldAt

public void setFieldAt(Field obj,
                       int index)
                throws java.lang.IndexOutOfBoundsException

removeField

public void removeField(Field obj)

removeFieldAt

public void removeFieldAt(int index)
                   throws java.lang.IndexOutOfBoundsException

getLink

public java.util.Vector getLink()

Get the Link property.

getLinkAt

public Link getLinkAt(int index)
               throws java.lang.IndexOutOfBoundsException

getLinkCount

public int getLinkCount()

Get the count of elements in the Link property.

setLink

public void setLink(java.util.Vector newList)

Set the Link property.

addLink

public void addLink(Link obj)

setLinkAt

public void setLinkAt(Link obj,
                      int index)
               throws java.lang.IndexOutOfBoundsException

removeLink

public void removeLink(Link obj)

removeLinkAt

public void removeLinkAt(int index)
                  throws java.lang.IndexOutOfBoundsException

getData

public Data getData()

Get the Data property.

setData

public void setData(Data obj)

Set the Data property.

getData$Contents

public java.lang.Object getData$Contents()

Get the content of the Data choice list.

hasData

public boolean hasData()

Checks for whether Data is set or not.

Returns:

true if Data is set, false if not

deleteData

public void deleteData()

Discards Data's value.

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