VOTableUtil
Class Definitions

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

All Implemented Interfaces:

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

public class Definitions

extends java.lang.Object

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

Definitions class.

See Also:

Serialized Form

Field Summary

protected java.util.Vector	_$Contents
protected static com.tbf.xml.XmlValidator	_$Contents_validator_
protected Coosys	_Coosys Declarations for the XML related fields.
protected static com.tbf.xml.XmlValidator	_Coosys_validator_
protected java.util.Vector	_doc_declared_namespaces_ Storage for namespaces declared in the input document.
protected boolean	_is_self_container_
protected static com.tbf.xml.XmlNamespaceManager	_nsm_ The default XmlNamespaceManager for this class.
protected Param	_Param
protected static com.tbf.xml.XmlValidator	_Param_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	$COOSYS Constant for "COOSYS" node name.
static java.lang.String	$DEFINITIONS Constant for "DEFINITIONS" node name.
static java.lang.String	$PARAM Constant for "PARAM" node name.

Constructor Summary

Definitions()
Default no args constructor.

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

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

Method Summary

void	add$Content(Definitions obj)
java.util.Vector	contents() Get the List holding the content for this repeating sequence.
protected static void	createValidators() Create the validators for this class.
void	deleteCoosys() Discards Coosys's value.
void	deleteParam() Discards Param's value.
void	fromXml(com.tbf.xml.XmlElement xml) Deprecated. will be removed in a future release. Use unmarshal(XmlElement).
int	get$ContentCount() Get the count of elements in the $Contents property.
java.util.Vector	get$Contents() Get the $Contents property.
Definitions	get$ContentsAt(int index)
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.
Coosys	getCoosys() Get the Coosys property.
Param	getParam() Get the Param 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	hasCoosys() Checks for whether Coosys is set or not.
boolean	hasParam() Checks for whether Param 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	remove$Content(Definitions obj)
void	remove$ContentAt(int index)
void	set$ContentAt(Definitions obj, int index)
void	set$Contents(java.util.Vector newList) Set the $Contents property.
void	set$Parent(com.tbf.xml.XmlObject parent) Set this object's parent object.
void	setCoosys(Coosys obj) Set the Coosys property.
void	setParam(Param obj) Set the Param 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 Definitions	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

$DEFINITIONS

public static final java.lang.String $DEFINITIONS

Constant for "DEFINITIONS" node name.

$PARAM

public static final java.lang.String $PARAM

Constant for "PARAM" node name.

$COOSYS

public static final java.lang.String $COOSYS

Constant for "COOSYS" node name.

_Coosys

protected Coosys _Coosys

Declarations for the XML related fields.

_Param

protected Param _Param

_$Contents

protected java.util.Vector _$Contents

_is_self_container_

protected boolean _is_self_container_

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

_Coosys_validator_

protected static transient com.tbf.xml.XmlValidator _Coosys_validator_

_Param_validator_

protected static transient com.tbf.xml.XmlValidator _Param_validator_

_$Contents_validator_

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

Definitions

public Definitions()

Default no args constructor.

Definitions

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

Creates and populates an instance from the provided parse tree.

Parameters:

xml - the parse tree

Definitions

public Definitions(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.util.Vector contents()

Get the List holding the content for this repeating sequence.

getCoosys

public Coosys getCoosys()

Get the Coosys property.

setCoosys

public void setCoosys(Coosys obj)

Set the Coosys property.

hasCoosys

public boolean hasCoosys()

Checks for whether Coosys is set or not.

Returns:

true if Coosys is set, false if not

deleteCoosys

public void deleteCoosys()

Discards Coosys's value.

getParam

public Param getParam()

Get the Param property.

setParam

public void setParam(Param obj)

Set the Param property.

hasParam

public boolean hasParam()

Checks for whether Param is set or not.

Returns:

true if Param is set, false if not

deleteParam

public void deleteParam()

Discards Param's value.

get$Contents

public java.util.Vector get$Contents()

Get the $Contents property.

get$ContentsAt

public Definitions get$ContentsAt(int index)
                           throws java.lang.IndexOutOfBoundsException

get$ContentCount

public int get$ContentCount()

Get the count of elements in the $Contents property.

set$Contents

public void set$Contents(java.util.Vector newList)

Set the $Contents property.

add$Content

public void add$Content(Definitions obj)

set$ContentAt

public void set$ContentAt(Definitions obj,
                          int index)
                   throws java.lang.IndexOutOfBoundsException

remove$Content

public void remove$Content(Definitions obj)

remove$ContentAt

public void remove$ContentAt(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 Definitions 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