org.xtce.toolkit

Class XTCETCContainer

java.lang.Object

org.xtce.toolkit.XTCENamedObject

org.xtce.toolkit.XTCETCContainer

All Implemented Interfaces:

Comparable

public class XTCETCContainer
extends XTCENamedObject

The XTCETCContainer class models the XTCE CommandContainer 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 XTCETCContainer objects when sorted based upon their inheritance path rather than the Space System path.
CommandContainerType	getCommandContainerReference() Retrieve a reference to the CommandContainer element in the JAXB generated classes for the XTCE data model.
String	getDescription() Retrieves the preferred effective description of this Container in the XTCE data model.
String	getInheritancePath() Retrieve the inheritance path for this CommandContainer.
String	getLongDescription() Retrieve the LongDescription element text for this CommandContainer.
String	getShortDescription() Retrieve the shortDescription attribute for this CommandContainer.
void	setLongDescription(String description) Sets the Long Description element text for this CommandContainer.
void	setShortDescription(String description) Sets the shortDescription attribute for this CommandContainer.
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

getCommandContainerReference

public final CommandContainerType getCommandContainerReference()

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

Returns:

CommandContainerType element represented by this object.

getInheritancePath

public final String getInheritancePath()

Retrieve the inheritance path for this CommandContainer.

Returns:

String containing the inheritance path to this container.

getShortDescription

public final String getShortDescription()

Retrieve the shortDescription attribute for this CommandContainer.

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

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

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 XTCETCContainer 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 - XTCETCContainer object to compare to.

Returns:

Integer value of -1, 0, or 1.

See Also:

Comparable