VOTableUtil
Class Votable

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

All Implemented Interfaces:

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

public class Votable

extends java.lang.Object

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

Votable class.

See Also:

Serialized Form

Field Summary

protected Definitions	_Definitions
protected static com.tbf.xml.XmlValidator	_Definitions_validator_
protected java.lang.String	_Description
protected java.util.Vector	_doc_declared_namespaces_ Storage for namespaces declared in the input document.
protected java.lang.String	_Id Declarations for the XML related fields.
protected java.util.Vector	_Info
protected static com.tbf.xml.XmlValidator	_Info_validator_
protected static com.tbf.xml.XmlNamespaceManager	_nsm_ The default XmlNamespaceManager for this class.
protected java.util.Vector	_Resource
protected static com.tbf.xml.XmlValidator	_Resource_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.
protected java.lang.String	_Version
static java.lang.String	$DEFINITIONS Constant for "DEFINITIONS" node name.
static java.lang.String	$DESCRIPTION Constant for "DESCRIPTION" node name.
static java.lang.String	$ID Constant for "ID" node name.
static java.lang.String	$INFO Constant for "INFO" node name.
static java.lang.String	$RESOURCE Constant for "RESOURCE" node name.
static java.lang.String	$VERSION Constant for "version" node name.
static java.lang.String	$VOTABLE Constant for "VOTABLE" node name.

Constructor Summary

Votable()
Default no args constructor.

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

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

Method Summary

void	addInfo(Info obj)
void	addResource(Resource obj)
protected static void	createValidators() Create the validators for this class.
void	deleteDefinitions() Discards Definitions's value.
void	deleteDescription() Discards Description's value.
void	deleteId() Discards Id's value.
void	deleteVersion() Discards Version'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.
Definitions	getDefinitions() Get the Definitions property.
java.lang.String	getDescription() Get the Description property.
java.lang.String	getId() Get the Id property.
java.util.Vector	getInfo() Get the Info property.
Info	getInfoAt(int index)
int	getInfoCount() Get the count of elements in the Info property.
java.util.Vector	getResource() Get the Resource property.
Resource	getResourceAt(int index)
int	getResourceCount() Get the count of elements in the Resource 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	getVersion() Get the Version property.
java.lang.String	getXmlTagName() Gets the XML tag name for this object.
boolean	hasDefinitions() Checks for whether Definitions 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	hasVersion() Checks for whether Version 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	removeInfo(Info obj)
void	removeInfoAt(int index)
void	removeResource(Resource obj)
void	removeResourceAt(int index)
void	set$Parent(com.tbf.xml.XmlObject parent) Set this object's parent object.
void	setDefinitions(Definitions obj) Set the Definitions property.
void	setDescription(java.lang.String newValue) Set the Description property.
void	setId(java.lang.String newValue) Set the Id property.
void	setInfo(java.util.Vector newList) Set the Info property.
void	setInfoAt(Info obj, int index)
void	setResource(java.util.Vector newList) Set the Resource property.
void	setResourceAt(Resource obj, int index)
void	setVersion(java.lang.String newValue) Set the Version 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 Votable	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

$ID

public static final java.lang.String $ID

Constant for "ID" node name.

$DEFINITIONS

public static final java.lang.String $DEFINITIONS

Constant for "DEFINITIONS" node name.

$VERSION

public static final java.lang.String $VERSION

Constant for "version" node name.

$INFO

public static final java.lang.String $INFO

Constant for "INFO" node name.

$DESCRIPTION

public static final java.lang.String $DESCRIPTION

Constant for "DESCRIPTION" node name.

$RESOURCE

public static final java.lang.String $RESOURCE

Constant for "RESOURCE" node name.

$VOTABLE

public static final java.lang.String $VOTABLE

Constant for "VOTABLE" node name.

_Id

protected java.lang.String _Id

Declarations for the XML related fields.

_Version

protected java.lang.String _Version

_Description

protected java.lang.String _Description

_Definitions

protected Definitions _Definitions

_Info

protected java.util.Vector _Info

_Resource

protected java.util.Vector _Resource

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

_Definitions_validator_

protected static transient com.tbf.xml.XmlValidator _Definitions_validator_

_Info_validator_

protected static transient com.tbf.xml.XmlValidator _Info_validator_

_Resource_validator_

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

Votable

public Votable()

Default no args constructor.

Votable

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

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

Votable

public Votable(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.

getVersion

public java.lang.String getVersion()

Get the Version property.

setVersion

public void setVersion(java.lang.String newValue)

Set the Version property.

hasVersion

public boolean hasVersion()

Checks for whether Version is set or not.

Returns:

true if Version is set, false if not

deleteVersion

public void deleteVersion()

Discards Version'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.

getDefinitions

public Definitions getDefinitions()

Get the Definitions property.

setDefinitions

public void setDefinitions(Definitions obj)

Set the Definitions property.

hasDefinitions

public boolean hasDefinitions()

Checks for whether Definitions is set or not.

Returns:

true if Definitions is set, false if not

deleteDefinitions

public void deleteDefinitions()

Discards Definitions's value.

getInfo

public java.util.Vector getInfo()

Get the Info property.

getInfoAt

public Info getInfoAt(int index)
               throws java.lang.IndexOutOfBoundsException

getInfoCount

public int getInfoCount()

Get the count of elements in the Info property.

setInfo

public void setInfo(java.util.Vector newList)

Set the Info property.

addInfo

public void addInfo(Info obj)

setInfoAt

public void setInfoAt(Info obj,
                      int index)
               throws java.lang.IndexOutOfBoundsException

removeInfo

public void removeInfo(Info obj)

removeInfoAt

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

getResource

public java.util.Vector getResource()

Get the Resource property.

getResourceAt

public Resource getResourceAt(int index)
                       throws java.lang.IndexOutOfBoundsException

getResourceCount

public int getResourceCount()

Get the count of elements in the Resource property.

setResource

public void setResource(java.util.Vector newList)

Set the Resource property.

addResource

public void addResource(Resource obj)

setResourceAt

public void setResourceAt(Resource obj,
                          int index)
                   throws java.lang.IndexOutOfBoundsException

removeResource

public void removeResource(Resource obj)

removeResourceAt

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

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