Package org.xtce.toolkit

Class XTCEContainerContentModel

java.lang.Object

org.xtce.toolkit.XTCEContainerContentModelBase

org.xtce.toolkit.XTCEContainerContentModel

public class XTCEContainerContentModel
extends XTCEContainerContentModelBase

The container content model class encapsulates the pre-processing of an XTCE SequenceContainer into a series of rows suitable for a simple iterator.

Author:

David Overeem

Nested Class Summary

Nested classes/interfaces inherited from class org.xtce.toolkit.XTCEContainerContentModelBase

XTCEContainerContentModelBase.RunningStartBit

Field Summary

Fields inherited from class org.xtce.toolkit.XTCEContainerContentModelBase

containerDescription_, containerName_, contentList_, contentValues_, exhaustedBinaryBitSupply_, showAllConditions_, spaceSystems_, totalContainerSize_, warnings_

Constructor Summary

Constructors

Constructor	Description
XTCEContainerContentModel(XTCETMContainer container, List<XTCESpaceSystem> spaceSystems, BitSet binaryData)	Constructor This constructor creates the container content model object with TM parameter values evaluated from the binary provided in a BitSet.
XTCEContainerContentModel(XTCETMContainer container, List<XTCESpaceSystem> spaceSystems, List<XTCEContainerEntryValue> userValues, boolean showAllConditions)	Constructor This constructor creates the container content model object with some optional user values provided in a list.

Method Summary

Modifier and Type	Method	Description
XTCETMContainer	getContainerReference()	Accessor to get the reference to the XTCETMContainer object that this model represents.
long	processContainer()	This method processes the contents of the entire container into an ArrayList of XTCEContainerContentEntry objects.

Methods inherited from class org.xtce.toolkit.XTCEContainerContentModelBase

addArrayEntryDescription, addIncludeCondition, addIncludeConditions, addRepeatEntryDescription, addStartBit, applyBinaryValue, applyRestriction, applyRestrictions, applyUserValue, checkForOverlaps, dynamicCountFromUserValue, encodeContainer, evaluateContainerReferenceLocation, evaluateIncludeConditions, extractRawValue, findContainer, findParameter, findTelecommand, getBytesRequired, getContentList, getDescription, getName, getTotalSize, getUserValues, getWarnings, isEntryConditionSatisfied, isEntryNeedingStartBit, isProcessingCompatible, isValid, processEndOfContainer, reorderItemsByStartBit, setShowAllConditionals

Methods inherited from class java.lang.Object

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

Constructor Detail

XTCEContainerContentModel

public XTCEContainerContentModel(XTCETMContainer container,
                                 List<XTCESpaceSystem> spaceSystems,
                                 List<XTCEContainerEntryValue> userValues,
                                 boolean showAllConditions)
                          throws XTCEDatabaseException

Constructor This constructor creates the container content model object with some optional user values provided in a list. Major problems processing the container will result in an exception, but many problems encountered do not inhibit continuation. These can be inspected by calling getWarnings() after this method to retrieve any non-blocking issue descriptions.

Parameters:

container - XTCETMContainer from the database object that contains all the needed entry list items.

spaceSystems - List of XTCESpaceSystem objects to search for entries on the entry list.

userValues - List of XTCEContainerEntryValue objects for TM Parameters that are within the container. This can be null if no values are needed to be passed into conditional processing.

showAllConditions - boolean indicating if unsatisfied conditional includes should be pursued at depth. This can be a performance hit if there are a large number of conditionals nested.

Throws:

XTCEDatabaseException - in the event that the container cannot be completely processed.

XTCEContainerContentModel

public XTCEContainerContentModel(XTCETMContainer container,
                                 List<XTCESpaceSystem> spaceSystems,
                                 BitSet binaryData)
                          throws XTCEDatabaseException

Constructor This constructor creates the container content model object with TM parameter values evaluated from the binary provided in a BitSet. Major problems processing the container will result in an exception, but many problems encountered do not inhibit continuation. These can be inspected by calling getWarnings() after this method to retrieve any non-blocking issue descriptions.

Parameters:

container - XTCETMContainer from the database object that contains all the needed entry list items.

spaceSystems - List of XTCESpaceSystem objects to search for entries on the entry list.

binaryData - BitSet containing a map of the binary data that makes up a binary instance of the container. The first bit in the set should be the zeroth bit of the container binary (start bit 0) and may be short in the event that there are trailing zeros.

Throws:

XTCEDatabaseException - in the event that the container cannot be completely processed.

Method Detail

getContainerReference

public final XTCETMContainer getContainerReference()

Accessor to get the reference to the XTCETMContainer object that this model represents.

Returns:

XTCETMContainer that is represented by this model object.

processContainer

public final long processContainer()
                            throws XTCEDatabaseException

This method processes the contents of the entire container into an ArrayList of XTCEContainerContentEntry objects. Major problems processing the container will result in an exception, but many problems encountered do not inhibit continuation. These can be inspected by calling getWarnings() after this method to retrieve any non-blocking issue descriptions.

Returns:

long containing the total length of this content/container entry.

Throws:

XTCEDatabaseException - thrown in the event that this container cannot be processed.