org.xtce.toolkit

Class XTCETMContainer

java.lang.Object

org.xtce.toolkit.XTCENamedObject

org.xtce.toolkit.XTCETMContainer

All Implemented Interfaces:

Comparable

public class XTCETMContainer
extends XTCENamedObject

The XTCETMContainer class models the XTCE SequenceContainer element by simplifying the usage by pre-modeling the relationships.

Author:

David Overeem

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object that) Comparison method used to order the XTCETMContainer objects when sorted based upon their inheritance path rather than the Space System path.
boolean	contains(XTCEParameter parameter) Function to test if this container includes an XTCEParameter.
String	getDescription() Retrieves the preferred effective description of this Container in the XTCE data model.
String	getInheritancePath() Retrieve the inheritance path for this SequenceContainer.
String	getLongDescription() Retrieve the LongDescription element text for this SequenceContainer.
org.omg.space.xtce.SequenceContainerType	getSequenceContainerReference() Retrieve a reference to the SequenceContainer element in the JAXB generated classes for the XTCE data model.
String	getShortDescription() Retrieve the shortDescription attribute for this SequenceContainer.
boolean	isAbstract() Retrieve the abstract flag for this SequenceContainer.
void	setLongDescription(String description) Sets the Long Description element text for this SequenceContainer.
void	setShortDescription(String description) Sets the shortDescription attribute for this SequenceContainer.
String	toXml() Retrieve an XML string that represents this Container element.

Methods inherited from class org.xtce.toolkit.XTCENamedObject

equals, getAlias, getAliasSet, getAncillaryData, getAncillaryData, getFullPath, getName, getPrimaryLongDescription, getPrimaryShortDescription, getSpaceSystemName, getSpaceSystemPath, hashCode, populateAliasListFromReference, setPrimaryLongDescription, setPrimaryShortDescription

Methods inherited from class java.lang.Object

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

Method Detail

getSequenceContainerReference

public final org.omg.space.xtce.SequenceContainerType getSequenceContainerReference()

Retrieve a reference to the SequenceContainer element in the JAXB generated classes for the XTCE data model.

Returns:

SequenceContainerType element represented by this object.

isAbstract

public final boolean isAbstract()

Retrieve the abstract flag for this SequenceContainer.

Returns:

boolean indicating if this container should be represented as an abstract container.

getInheritancePath

public final String getInheritancePath()

Retrieve the inheritance path for this SequenceContainer. The "inheritance path" is different from the SpaceSystem locating path in that it represents the parent SequenceContainer elements leading to this element through the BaseContainer element in the XTCE data model.

Returns:

String containing the inheritance path to this container.

getShortDescription

public final String getShortDescription()

Retrieve the shortDescription attribute for this SequenceContainer.

Returns:

String containing the short description, or an empty string if no short description is present.

setShortDescription

public final void setShortDescription(String description)

Sets the shortDescription attribute for this SequenceContainer. In the event that the description is null or an empty string, then the attribute will be removed from the element for compression.

Parameters:

description - String containing the new short description or an empty string (null tolerated) to remove the attribute.

getLongDescription

public final String getLongDescription()

Retrieve the LongDescription element text for this SequenceContainer.

Returns:

String containing the long description, or an empty string if no long description is present.

setLongDescription

public final void setLongDescription(String description)

Sets the Long Description element text for this SequenceContainer. In the event that the description is null or an empty string, then the element will be removed for compression.

Parameters:

description - String containing the new long description or an empty string (null tolerated) to remove the element.

getDescription

public final String getDescription()

Retrieves the preferred effective description of this Container in the XTCE data model. This method prefers the shortDescription attribute if it exists. If it does not, then the LongDescription element will be used if present.

Returns:

String containing a single description text item for this Container, generally suitable for display tables. The String will never be null.

contains

public final boolean contains(XTCEParameter parameter)

Function to test if this container includes an XTCEParameter.

Parameters:

parameter - XTCEParameter to search in the container entry list.

Returns:

Boolean indicating if this container entry list references the requested parameter.

toXml

public final String toXml()
                   throws XTCEDatabaseException

Retrieve an XML string that represents this Container element.

Returns:

String containing the XML fragment.

Throws:

XTCEDatabaseException - in the event that the elements being marshaled from the JAXB internal classes cannot make a valid document. Check the exception message for causality information.

compareTo

public int compareTo(Object that)

Comparison method used to order the XTCETMContainer objects when sorted based upon their inheritance path rather than the Space System path. Sorting by inheritance path is used by the graphical interface for the generation of tree nodes.

Specified by:

compareTo in interface Comparable

Overrides:

compareTo in class XTCENamedObject

Parameters:

that - XTCETMContainer object to compare to.

Returns:

Integer value of -1, 0, or 1.

See Also:

Comparable