com.infoengine.object
Class IeNode

java.lang.Object
  extended bycom.infoengine.object.IeObject
      extended bycom.infoengine.object.IeNode
All Implemented Interfaces:
AttributeContainer, Cloneable, Externalizable, Serializable

public class IeNode
extends IeObject
implements AttributeContainer, Externalizable, Cloneable

See Also:
Serialized Form

Field Summary
private static String _serialVersion
           
static String CLASS_KEY
           
private static String CLASSNAME
           
private  ConstraintContainer constraintContainer
           
private  Map deletedDatums
           
private  DescriptorContainer descriptorContainer
           
static String FTI_KEY
           
private  ContentChangedListenerManager listenerManager
           
static String OBID_KEY
           
 
Fields inherited from class com.infoengine.object.IeObject
_attributes, _children, _hasChanged, _meta, _name, _type, INITIAL_LIST_SIZE, INITIAL_MAP_SIZE, USE_COLLECTIONS
 
Constructor Summary
IeNode()
          Constructs a new IeNode
IeNode(AttributeContainer container)
          Constructs a new IeNode from a generic AttributeContainer.
IeNode(HashMap contentMap, HashMap stateMap)
          Constructs a new IeNode from a content map and a state map that are both keyed by AttributeIdentifier.
IeNode(String name)
          Constructs a new IeNode and sets the node name to the given String.
 
Method Summary
private  Vector _expandTypeInstanceIdentifier(TypeInstanceIdentifier id)
           
private  Object _getKeyFrom(HashMap map, Object oldKey)
           
private  boolean _hasInContext(AttributeIdentifier attrId, AssociationIdentifier associationId)
           
private  boolean _hasInContext(AttributeTypeIdentifier attrTypeId, AssociationTypeIdentifier associationTypeId)
           
private  void _merge(AttributeContainer container, AttributeIdentifier[] aids, AttributeIdentifier[] otherAids)
           
private  AttributeIdentifier _put(AttributeIdentifier attrId, Object content, State state)
          Puts a specified attribute, with state, into this instance.
private  void _remove(AttributeTypeIdentifier attrTypeId, IeDatum datum)
           
 void acceptChanges()
          

Supported API: false
 void acceptDefaultContent()
          Modifies all attribute values whose content is in the DEFAULT state such that their state is NEW.
 void addContentChangedListener(ContentChangedListener listener)
          

Supported API: false
 void addDatum(IeDatum datum)
          Adds an attribute value by attribute identifier.
 void addNode(IeNode node)
          Adds a child node to the node.
 void addReplacement(ElementIdentifier old_id, ElementIdentifier new_id)
          

Supported API: false
 void clearReplacements()
          

Supported API: false
 AttributeContainer clone(AttributeTypeIdentifier[] filter, boolean compact)
          

Supported API: false
 AttributeContainer clone(boolean compact)
          

Supported API: true
 AttributeContainer cloneWithNewCenter(TypeInstanceIdentifier typeInstanceId)
          

Supported API: false
 AttributeContainer cloneWithNewUninitializedIdentifiers(HashMap map)
          

Supported API: false
 boolean contains(AttributeIdentifier attrId)
          Returns true if this instance contains an attribute specified by AttributeIdentifier.
 AttributeContainer[] decompose(boolean compact)
          

Supported API: false
 Object deepClone()
          Returns a deep copy of the node.
 AttributeContainer[] extract(TypeIdentifier typeId)
          

Supported API: false
 AttributeContainer[] extract(TypeIdentifier typeId, boolean navigate)
          

Supported API: false
 AttributeContainer extract(TypeInstanceIdentifier typeInstanceId)
          

Supported API: false
 AttributeContainer extract(TypeInstanceIdentifier typeInstanceId, boolean navigate)
          

Supported API: false
 AttributeContainer[] extractCopies(TypeIdentifier typeId, boolean navigate, boolean compact)
          

Supported API: false
 AttributeContainer extractCopy(TypeInstanceIdentifier the_type_instance_identifier, AttributeTypeIdentifier[] filter, boolean compact)
          

Supported API: false
 AttributeContainer extractCopy(TypeInstanceIdentifier typeInstanceId, boolean navigate, boolean compact)
          

Supported API: false
 Object get(AttributeIdentifier attrId)
          Get the content associated with this AttributeIdentifier.
 Object get(AttributeTypeIdentifier attrTypeId)
          Get the content associated with this AttributeTypeIdentifier.
 AssociationIdentifier[] getAssociationIdentifiers(TypeIdentifier typeId)
          Returns all association identifiers for attributes in the contains that match a specific type identifier.
 AssociationIdentifier[] getAssociationIdentifiers(TypeIdentifier typeId, State state)
          Returns all association identifiers for attributes in the container that match a specific type identifier and state.
 AssociationIdentifier[] getAssociationIdentifiers(TypeInstanceIdentifier typeInstanceId)
          Returns all current AssociationIdentifiers in this container that are equivalent to the given TypeInstanceIdentifier.
 AssociationIdentifier[] getAssociationIdentifiers(TypeInstanceIdentifier typeInstanceId, State state)
          Returns all AssociationIdentifiers in this container that are equivalent to the given TypeInstanceIdentifier and that match the given state.
 IeAtt getAtt(AttributeTypeIdentifier attrTypeId)
          Returns an attribute by attribute type identifier.
 AttributeIdentifier[] getAttributeIdentifiers()
          Returns all AttributeIdentifiers from this container.
 AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId)
          Returns attribute identifiers of all attributes from the container that have a specific association identifier in their context.
 AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId, AttributeTypeIdentifier attrTypeId, boolean isAbsolute)
          Returns all current AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier and associated with the given AttributeTypeIdentifier.
 AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId, AttributeTypeIdentifier attrTypeId, boolean isAbsolute, State state)
          Returns all AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier and associated with the given AttributeTypeIdentifier and that match the given state.
 AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId, State state)
          Returns all AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier that match the given state.
 AttributeIdentifier[] getAttributeIdentifiers(AttributeTypeIdentifier attrTypeId)
          Returns all attribute identifiers from this container associated with a specific attribute type identifier.
 AttributeIdentifier[] getAttributeIdentifiers(AttributeTypeIdentifier attrTypeId, State state)
          Returns all attribute identifiers of attributes from this container that match a specific attribute type identifier and attribute state.
 AttributeIdentifier[] getAttributeIdentifiers(State state)
          Returns all attribute identifiers of attribute values having a specific state.
 AttributeIdentifier[] getAttributeIdentifiers(String logicalForm)
          Returns all current AttributeIdentifiers in this container associated with an AttributeTypeIdentifier which matches the given logical form.
 AttributeIdentifier[] getAttributeIdentifiers(TypeInstanceIdentifier the_type_instance_identifier)
          Returns all current AttributeIdentifiers in this container defined directly in the context of the given TypeInstanceIdentifier.
 AttributeIdentifier[] getAttributeIdentifiers(TypeInstanceIdentifier the_type_instance_identifier, State the_state)
          Returns all AttributeIdentifiers in this container defined directly in the context of the given TypeInstanceIdentifier that match the given state.
 AttributeTypeIdentifier[] getAttributeTypeIdentifiers()
          Returns all unique AttributeTypeIdentifiers from this container.
 AttributeTypeIdentifier[] getAttributeTypeIdentifiers(String logicalForm)
          Returns all current AttributeTypeIdentifiers in this container that match the given logical form.
 AttributeTypeSummary getAttributeTypeSummary(AssociationIdentifier the_association_identifier, AttributeTypeIdentifier the_attribute_type_identifier, boolean is_absolute)
          Returns an AttributeTypeSummary for the AttributeTypeIdentifier.
 AttributeTypeSummary getAttributeTypeSummary(AssociationIdentifier the_association_identifier, AttributeTypeIdentifier the_attribute_type_identifier, boolean is_absolute, ConstraintContainer the_constraint_container, DescriptorContainer the_descriptor_container)
          Returns an AttributeTypeSummary for the AttributeTypeIdentifier.
 AttributeTypeSummary getAttributeTypeSummary(AttributeTypeIdentifier attrTypeId)
          Retrieves the AttributeTypeSummary for the AttributeTypeIdentifier.
 AttributeTypeSummary getAttributeTypeSummary(AttributeTypeIdentifier the_attribute_type_identifier, ConstraintContainer the_constraint_container, DescriptorContainer the_descriptor_container)
          Returns an AttributeTypeSummary for the AttributeTypeIdentifier.
 AttributeTypeSummary getAttributeTypeSummary(String name)
          Retrieves the AttributeTypeSummary for the attribute specified by logical identifier.
 ConstraintContainer getConstraintContainer()
          Returns the constraint container associated with this instance.
 Object getContent(AttributeIdentifier attrId)
          Returns the content associated with an attribute specified by attribute identifier.
 IeDatum getDatum(AttributeIdentifier attrId)
          Returns an attribute value by attribute identifier.
 DefinitionDescriptor getDescriptor(DefinitionIdentifier defnId)
          Get the descriptor for this DefinitionIdentifier.
 DescriptorContainer getDescriptorContainer()
          Returns the descriptor container associated with this instance.
 String getFti()
          Returns the federated type identifier of this node.
 ElementIdentifier getIdentifier()
          

Supported API: false
 Object getInternal(AttributeIdentifier the_attribute_identifier)
          

Supported API: false
 IeNode getNode(String name)
          Returns a child node by name.
 String getNodeName()
          Returns the DOM node name of this object.
 Enumeration getNodes()
          Returns all of the child nodes of the node.
 HashMap getReplacements()
          

Supported API: false
 Object getSingle(AttributeTypeIdentifier attrTypeId)
          Get the single content associated with this AttributeTypeIdentifier.
 Object getSingle(String logicalForm)
          Returns the content associated with all AttributeTypeIdentifiers matching the given logical form in this container.
 State getState(AttributeIdentifier attrId)
          Returns the state of the content associated with a specific attribute identifier.
 String getUfid()
          Returns the unique federation identifier of this node.
 boolean isContentOfState(AttributeIdentifier attrId, State state)
          Returns true if the content associated with a specific attribute identifier is considered to be in a specific state.
 boolean isDirty()
          Returns true if any attribute values have been modified, added, or removed from the container, otherwise returns false.
 void merge(AttributeContainer container)
          Combines the content of another container with this one.
 void merge(AttributeContainer container, AssociationIdentifier relationship)
          

Supported API: false
 void merge(AttributeContainer container, AssociationIdentifier relationship, boolean containerHasPriority)
          

Supported API: false
 void merge(AttributeContainer container, boolean containerHasPriority)
          

Supported API: false
 void purge(AttributeIdentifier attrId)
          

Supported API: false
 void purge(AttributeTypeIdentifier attrTypeId)
          

Supported API: false
 void purge(TypeIdentifier typeId)
          

Supported API: false
 void purge(TypeInstanceIdentifier typeInstanceId)
          

Supported API: false
 void purge(TypeInstanceIdentifier[] the_type_instance_identifiers)
          

Supported API: false
 void purge(TypeInstanceIdentifier typeInstanceId, TypeInstanceIdentifier[] preserve)
          

Supported API: false
 void purgeAllBut(AttributeTypeIdentifier[] attrTypeIds)
          Removes all attributes except ones with the specified types.
 void purgeAllContent()
          

Supported API: false
 void purgeDefaultContent()
          Removes all content that is considered DEFAULT.
 void purgeDuplicateContent()
          

Supported API: false
 void purgeNonDirtyContent()
          Removes all content who's state is DEFAULT, UNCHANGED, or UNINITIALIZED.
 AttributeIdentifier put(AttributeIdentifier attrId, Object content)
          Store this content and associate it with this AttributeIdentifier in the container.
 AttributeIdentifier put(AttributeIdentifier the_attribute_identifier, Object the_content, ConstraintContainer the_constraint_container)
          Stores the given content in this container, in assocation with the given AttributeIdentifier.
 void readExternal(ObjectInput in)
           
 void remove(AttributeIdentifier attrId)
          Remove this AttributeIdentifier and it's content from the container.
 void remove(AttributeIdentifier the_attribute_identifier, ConstraintContainer the_constraint_container)
          Deletes the content associated with the given AttributeIdentifier from this container.
 void remove(AttributeTypeIdentifier attrTypeId)
          Remove all AttributeIdentifiers, and their content, that have this AttributeTypeIdentifier.
 void remove(AttributeTypeIdentifier the_attribute_type_identifier, ConstraintContainer the_constraint_container)
          Deletes the content associated with all AttributeIdentifiers associated with the given AttributeTypeIdentifier from this container.
 void removeAllNodes()
          Removes all of the child nodes associated with the node.
 void removeContentChangedListener(ContentChangedListener listener)
          

Supported API: false
 void removeDatum(AttributeIdentifier attrId)
          Removes an attribute value by attribute identifier.
 void removeDatum(IeDatum datum)
          Removes an attribute value by attribute identifier.
 void removeNode(IeNode node)
          Removes a specified child node from the node.
 void replace(TypeInstanceIdentifier old_id, TypeInstanceIdentifier new_id)
          

Supported API: false
 void replaceContent(AttributeContainer newContent)
          

Supported API: false
 void setConstraintContainer(ConstraintContainer container)
          Sets the constraint container associated with this instance.
 void setDescriptorContainer(DescriptorContainer container)
          Sets the descriptor container associated with this instance.
 void setFti(String fti)
          Sets the federated type identifier of this node.
 void setState(AttributeIdentifier the_attribute_identifier, State the_state)
          Sets the state associated with the given AttributeIdentifier in this container.
 void setUfid(String ufid)
          Sets the unique federation identifier of this node.
 String toString()
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.infoengine.object.IeObject
_addChild, _addMeta, _getMeta, _removeChild, _setMeta, addAtt, addChild, addMeta, addMeta, addMeta, addMeta, addMetaDatum, addMetaValue, addMetaValues, appendMetaDatum, canonicalize, canonicalize, clearChildren, clone, containsChild, containsMetaValue, deepCopy, findChild, firstAtt, firstChild, firstMetaValue, getAtt, getAttAt, getAttByMeta, getAttCount, getAttribute, getAtts, getChildAt, getChildCount, getChildren, getHasChanged, getMeta, getMetaNames, getMetaValue, getMetaValueAt, getMetaValueCount, getMetaValues, getName, getTagName, getType, hasChildren, indexOfChild, indexOfMetaValue, lastAtt, lastChild, lastMetaValue, newList, newList, newMap, newMap, removeAllAtts, removeAllChildren, removeAllMeta, removeAllMetaValues, removeAtt, removeAtt, removeAttAt, removeAttribute, removeChild, removeChildAt, removeMeta, removeMetaValue, removeMetaValueAt, removeName, removeType, replaceChild, setAttAt, setAttribute, setChildAt, setHasChanged, setMeta, setMeta, setMeta, setMeta, setMetaValue, setMetaValueAt, setName, setType, shallowCopy
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ptc.core.meta.container.common.AttributeContainer
clone
 

Field Detail

CLASSNAME

private static final String CLASSNAME

CLASS_KEY

public static final String CLASS_KEY
See Also:
Constant Field Values

FTI_KEY

public static final String FTI_KEY
See Also:
Constant Field Values

OBID_KEY

public static final String OBID_KEY
See Also:
Constant Field Values

_serialVersion

private static final String _serialVersion
See Also:
Constant Field Values

listenerManager

private transient ContentChangedListenerManager listenerManager

deletedDatums

private Map deletedDatums

constraintContainer

private ConstraintContainer constraintContainer

descriptorContainer

private DescriptorContainer descriptorContainer
Constructor Detail

IeNode

public IeNode()
Constructs a new IeNode


IeNode

public IeNode(String name)
Constructs a new IeNode and sets the node name to the given String.

Parameters:
name - The name of the node

IeNode

public IeNode(AttributeContainer container)
Constructs a new IeNode from a generic AttributeContainer.

Parameters:
container - The AttributeContainer instance from which to construct this IeNode

IeNode

public IeNode(HashMap contentMap,
              HashMap stateMap)
       throws IllegalContentException,
              ConstraintException
Constructs a new IeNode from a content map and a state map that are both keyed by AttributeIdentifier.

Parameters:
contentMap - The content map
stateMap - The state map
Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class IeObject
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class IeObject
Throws:
IOException

addNode

public void addNode(IeNode node)
Adds a child node to the node.

Parameters:
node - the node to be added

removeNode

public void removeNode(IeNode node)
Removes a specified child node from the node.

Parameters:
node - the child node to be removed

removeAllNodes

public void removeAllNodes()
Removes all of the child nodes associated with the node.


getNode

public IeNode getNode(String name)
Returns a child node by name.

Parameters:
name - the name of the child node to be returned
Returns:
The named child node, or null if the node does not have any children

getNodes

public Enumeration getNodes()
Returns all of the child nodes of the node.

Returns:
The children

getNodeName

public String getNodeName()
Returns the DOM node name of this object.

Overrides:
getNodeName in class IeObject
Returns:
The DOM node name of this object.

deepClone

public final Object deepClone()
Returns a deep copy of the node.

Overrides:
deepClone in class IeObject
Returns:
The deep copy

getAttributeTypeIdentifiers

public AttributeTypeIdentifier[] getAttributeTypeIdentifiers()
Returns all unique AttributeTypeIdentifiers from this container.

Specified by:
getAttributeTypeIdentifiers in interface AttributeContainer
Returns:
AttributeTypeIdentifier[]

getAttributeTypeIdentifiers

public AttributeTypeIdentifier[] getAttributeTypeIdentifiers(String logicalForm)
Description copied from interface: AttributeContainer
Returns all current AttributeTypeIdentifiers in this container that match the given logical form. (Does not include AttributeTypeIdentifiers for which the state of every corresponding AttributeIdentifier is State.DELETED.) Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeTypeIdentifiers in interface AttributeContainer
Parameters:
logicalForm -
Returns:
AttributeTypeIdentifier[]

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers()
Returns all AttributeIdentifiers from this container.

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Returns:
AttributeIdentifier[]

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(State state)
Returns all attribute identifiers of attribute values having a specific state.

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
state - The state of attribute values for which to return identifiers.
Returns:
The matching attribute identifiers.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(AttributeTypeIdentifier attrTypeId)
Returns all attribute identifiers from this container associated with a specific attribute type identifier.

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
attrTypeId - The attribute type identifier to be matched.
Returns:
The attribute identifiers associated with the attribute type identifier.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(AttributeTypeIdentifier attrTypeId,
                                                     State state)
Returns all attribute identifiers of attributes from this container that match a specific attribute type identifier and attribute state.

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
attrTypeId - The attribute type identifier to match.
state - The state of attributes for which to return identifiers.
Returns:
The matching attribute identifiers.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId)
Returns attribute identifiers of all attributes from the container that have a specific association identifier in their context.

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
associationId - The association identifier.
Returns:
The matching attribute identifiers.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId,
                                                     State state)
Description copied from interface: AttributeContainer
Returns all AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier that match the given state. If the given state is null, returns all AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier. Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
associationId - The association identifier.
state - The state of attributes to match.
Returns:
The identifiers of matching attributes.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId,
                                                     AttributeTypeIdentifier attrTypeId,
                                                     boolean isAbsolute)
Description copied from interface: AttributeContainer
Returns all current AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier and associated with the given AttributeTypeIdentifier. If 'is_absolute' is true, then the given AttributeTypeIdentifier is assumed to be defined in the context of the AssociationTypeIdentifier corresponding to the given AssociationIdentifier. Otherwise, a new AttributeTypeIdentifier is constructed by merging the given AttributeTypeIdentifier onto the context of the AssociationTypeIdentifier corresponding to the given AssociationIdentifier. (Does not include AttributeIdentifiers for which the state is State.DELETED.) (Does not include AttributeIdentifiers for which the state is State.DEFAULT, unless there are no other AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier with matching AttributeTypeIdentifiers for which the state is not State.DEFAULT or State.DELETED.) Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
associationId - The association identifier.
attrTypeId - The attribute type identifier to match.
isAbsolute -
Returns:
The identifiers of matching attributes.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(AssociationIdentifier associationId,
                                                     AttributeTypeIdentifier attrTypeId,
                                                     boolean isAbsolute,
                                                     State state)
Description copied from interface: AttributeContainer
Returns all AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier and associated with the given AttributeTypeIdentifier and that match the given state. If 'is_absolute' is true, then the given AttributeTypeIdentifier is assumed to be defined in the context of the AssociationTypeIdentifier corresponding to the given AssociationIdentifier. Otherwise, a new AttributeTypeIdentifier is constructed by merging the given AttributeTypeIdentifier onto the context of the AssociationTypeIdentifier corresponding to the given AssociationIdentifier. If the given state is null, returns all AttributeIdentifiers in this container defined in the context of the given AssociationIdentifier and associated with the given AttributeTypeIdentifier. Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
associationId - The association identifier.
attrTypeId - The attribute type identifier to match.
isAbsolute -
state - The state to match.
Returns:
The identifiers of matching attributes.

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(String logicalForm)
Description copied from interface: AttributeContainer
Returns all current AttributeIdentifiers in this container associated with an AttributeTypeIdentifier which matches the given logical form. (Does not include AttributeIdentifiers for which the state is State.DELETED.) (Does not include AttributeIdentifiers for which the state is State.DEFAULT, unless there are no other AttributeIdentifiers with matching AttributeTypeIdentifiers in the container for which the state is not State.DEFAULT or State.DELETED.) Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
logicalForm -
Returns:
AttributeIdentifier[]

getAssociationIdentifiers

public AssociationIdentifier[] getAssociationIdentifiers(TypeInstanceIdentifier typeInstanceId)
Description copied from interface: AttributeContainer
Returns all current AssociationIdentifiers in this container that are equivalent to the given TypeInstanceIdentifier. (Does not include AssociationIdentifiers for which the state is State.DELETED.) (Does not include AssociationIdentifiers for which the state is State.DEFAULT, unless there are no other AssociationIdentifiers with matching AssociationTypeIdentifiers in the container for which the state is not State.DEFAULT or State.DELETED.) Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAssociationIdentifiers in interface AttributeContainer
Parameters:
typeInstanceId - The type instance identifier.
Returns:
The identifiers of matching attributes.

getAssociationIdentifiers

public AssociationIdentifier[] getAssociationIdentifiers(TypeInstanceIdentifier typeInstanceId,
                                                         State state)
Description copied from interface: AttributeContainer
Returns all AssociationIdentifiers in this container that are equivalent to the given TypeInstanceIdentifier and that match the given state. If the given state is null, returns all AssociationIdentifiers in this container that are equivalent to the given TypeInstanceIdentifier. Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAssociationIdentifiers in interface AttributeContainer
Parameters:
typeInstanceId -
state -
Returns:
The association identifiers

getAssociationIdentifiers

public AssociationIdentifier[] getAssociationIdentifiers(TypeIdentifier typeId)
Returns all association identifiers for attributes in the contains that match a specific type identifier.

Specified by:
getAssociationIdentifiers in interface AttributeContainer
Parameters:
typeId - The type identifier.
Returns:
The association identifiers.

getAssociationIdentifiers

public AssociationIdentifier[] getAssociationIdentifiers(TypeIdentifier typeId,
                                                         State state)
Returns all association identifiers for attributes in the container that match a specific type identifier and state.

Specified by:
getAssociationIdentifiers in interface AttributeContainer
Parameters:
typeId - The type identifier.
state - The state to match.
Returns:
The association identifiers.

get

public Object get(AttributeIdentifier attrId)
Get the content associated with this AttributeIdentifier. The return type should be one of the data content wrappers.

Specified by:
get in interface AttributeContainer
Parameters:
attrId - The identifier of the attribute to return.
Returns:
The content.

get

public Object get(AttributeTypeIdentifier attrTypeId)
Get the content associated with this AttributeTypeIdentifier. If there's only one AttributeIdentifier (content) associated with this AttributeTypeIdentifier, the return type should be one of the data content wrappers; otherwise, if more than one AttributeIdentifier (content) are associated, the return type should be an array of the data content wrappers.

Specified by:
get in interface AttributeContainer
Parameters:
attrTypeId - The attribute type identifier.
Returns:
The value(s)

getSingle

public Object getSingle(AttributeTypeIdentifier attrTypeId)
Get the single content associated with this AttributeTypeIdentifier. Note: This will return only a single Object, even if there is more than one content for the AttributeTypeIdentifier.

Specified by:
getSingle in interface AttributeContainer
Parameters:
attrTypeId - The attribute type identifier.
Returns:
The single object.

getSingle

public Object getSingle(String logicalForm)
Description copied from interface: AttributeContainer
Returns the content associated with all AttributeTypeIdentifiers matching the given logical form in this container. If there is exactly one AttributeIdentifier associated with the matching AttributeTypeIdentifiers in the container, the return value will be a single Object. If there is more than one AttributeIdentifier associated with the matching AttributeTypeIdentifiers in the container, the return value will be a single Object, selected randomly from the content associated with those AttributeIdentifiers. If there are no current AttributeIdentifiers associated with the matching AttributeTypeIdentifier in the container or there is no matching AttributeTypeIdentifier in the container, the return value will be null. (Does not include content for AttributeIdentifiers for which the state is State.DELETED.) (Does not include content for AttributeIdentifiers for which the state is State.DEFAULT, unless there are no other AttributeIdentifiers in this container with matching AttributeTypeIdentifiers for which the state is not State.DEFAULT or State.DELETED.) If the content is an AttributeContainerFunction, returns the result of calculate(this) called on the function.

Supported API: true

Specified by:
getSingle in interface AttributeContainer
Parameters:
logicalForm -
Returns:
Object

put

public AttributeIdentifier put(AttributeIdentifier attrId,
                               Object content)
                        throws IllegalContentException,
                               ConstraintException
Store this content and associate it with this AttributeIdentifier in the container.

Specified by:
put in interface AttributeContainer
Parameters:
attrId - The attribute identifier
content - The content
Returns:
The attribute identifier
Throws:
IllegalContentException
ConstraintException

remove

public void remove(AttributeIdentifier attrId)
            throws ConstraintException
Remove this AttributeIdentifier and it's content from the container.

Specified by:
remove in interface AttributeContainer
Parameters:
attrId - The identifier of the attribute to be removed.
Throws:
ConstraintException

remove

public void remove(AttributeTypeIdentifier attrTypeId)
            throws ConstraintException
Remove all AttributeIdentifiers, and their content, that have this AttributeTypeIdentifier.

Specified by:
remove in interface AttributeContainer
Parameters:
attrTypeId - The attribute type identifier.
Throws:
ConstraintException

getDescriptor

public DefinitionDescriptor getDescriptor(DefinitionIdentifier defnId)
Get the descriptor for this DefinitionIdentifier. If there's no DescriptorContainer associated, return null.

Specified by:
getDescriptor in interface AttributeContainer
Parameters:
defnId - The definition identifier
Returns:
The definition descriptor, if any

getAttributeTypeSummary

public AttributeTypeSummary getAttributeTypeSummary(AttributeTypeIdentifier attrTypeId)
Retrieves the AttributeTypeSummary for the AttributeTypeIdentifier.

Specified by:
getAttributeTypeSummary in interface AttributeContainer
Parameters:
attrTypeId - The attribute type identifier
Returns:
The attribute summary

getAttributeTypeSummary

public AttributeTypeSummary getAttributeTypeSummary(String name)
Retrieves the AttributeTypeSummary for the attribute specified by logical identifier.

Parameters:
name - The attribute name
Returns:
The attribute summary

isDirty

public boolean isDirty()
Returns true if any attribute values have been modified, added, or removed from the container, otherwise returns false.

Specified by:
isDirty in interface AttributeContainer
Returns:
true if the container is dirty

isContentOfState

public boolean isContentOfState(AttributeIdentifier attrId,
                                State state)
Returns true if the content associated with a specific attribute identifier is considered to be in a specific state.

Specified by:
isContentOfState in interface AttributeContainer
Parameters:
attrId - The attribute identifier
state - The state
Returns:
true if the content is in the specified state

getState

public State getState(AttributeIdentifier attrId)
Returns the state of the content associated with a specific attribute identifier.

Specified by:
getState in interface AttributeContainer
Parameters:
attrId - The attribute identifier of the value for which to return the state
Returns:
The state of the specified attribute

acceptDefaultContent

public void acceptDefaultContent()
Modifies all attribute values whose content is in the DEFAULT state such that their state is NEW.

Specified by:
acceptDefaultContent in interface AttributeContainer

decompose

public AttributeContainer[] decompose(boolean compact)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
decompose in interface AttributeContainer
Parameters:
compact -
Returns:
AttributeContainer[]

clone

public AttributeContainer clone(boolean compact)
Description copied from interface: AttributeContainer


Supported API: true

Specified by:
clone in interface AttributeContainer
Parameters:
compact -
Returns:
AttributeContainer

cloneWithNewCenter

public AttributeContainer cloneWithNewCenter(TypeInstanceIdentifier typeInstanceId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
cloneWithNewCenter in interface AttributeContainer
Parameters:
typeInstanceId -
Returns:
AttributeContainer

merge

public void merge(AttributeContainer container)
Combines the content of another container with this one.

Specified by:
merge in interface AttributeContainer
Parameters:
container - The container to be merged with this one.

merge

public void merge(AttributeContainer container,
                  AssociationIdentifier relationship)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
merge in interface AttributeContainer
Parameters:
container -
relationship -

merge

public void merge(AttributeContainer container,
                  boolean containerHasPriority)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
merge in interface AttributeContainer
Parameters:
container -
containerHasPriority -

merge

public void merge(AttributeContainer container,
                  AssociationIdentifier relationship,
                  boolean containerHasPriority)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
merge in interface AttributeContainer
Parameters:
container -
relationship -
containerHasPriority -

extract

public AttributeContainer extract(TypeInstanceIdentifier typeInstanceId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extract in interface AttributeContainer
Parameters:
typeInstanceId -
Returns:
AttributeContainer

extract

public AttributeContainer[] extract(TypeIdentifier typeId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extract in interface AttributeContainer
Parameters:
typeId -
Returns:
AttributeContainer[]

extract

public AttributeContainer extract(TypeInstanceIdentifier typeInstanceId,
                                  boolean navigate)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extract in interface AttributeContainer
Parameters:
typeInstanceId -
navigate -
Returns:
AttributeContainer

extractCopy

public AttributeContainer extractCopy(TypeInstanceIdentifier typeInstanceId,
                                      boolean navigate,
                                      boolean compact)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extractCopy in interface AttributeContainer
Parameters:
typeInstanceId -
navigate -
compact -
Returns:
AttributeContainer

extractCopies

public AttributeContainer[] extractCopies(TypeIdentifier typeId,
                                          boolean navigate,
                                          boolean compact)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extractCopies in interface AttributeContainer
Parameters:
typeId -
navigate -
compact -
Returns:
AttributeContainer[]

extract

public AttributeContainer[] extract(TypeIdentifier typeId,
                                    boolean navigate)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extract in interface AttributeContainer
Parameters:
typeId -
navigate -
Returns:
AttributeContainer[]

purge

public void purge(AttributeIdentifier attrId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purge in interface AttributeContainer
Parameters:
attrId -

purge

public void purge(AttributeTypeIdentifier attrTypeId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purge in interface AttributeContainer
Parameters:
attrTypeId -

purge

public void purge(TypeInstanceIdentifier typeInstanceId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purge in interface AttributeContainer
Parameters:
typeInstanceId -

purge

public void purge(TypeIdentifier typeId)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purge in interface AttributeContainer
Parameters:
typeId -

purge

public void purge(TypeInstanceIdentifier typeInstanceId,
                  TypeInstanceIdentifier[] preserve)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purge in interface AttributeContainer
Parameters:
typeInstanceId -
preserve -

purgeDefaultContent

public void purgeDefaultContent()
Removes all content that is considered DEFAULT.

Specified by:
purgeDefaultContent in interface AttributeContainer

purgeNonDirtyContent

public void purgeNonDirtyContent()
Removes all content who's state is DEFAULT, UNCHANGED, or UNINITIALIZED.

Specified by:
purgeNonDirtyContent in interface AttributeContainer

purgeDuplicateContent

public void purgeDuplicateContent()
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purgeDuplicateContent in interface AttributeContainer

purgeAllContent

public void purgeAllContent()
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purgeAllContent in interface AttributeContainer

purgeAllBut

public void purgeAllBut(AttributeTypeIdentifier[] attrTypeIds)
Removes all attributes except ones with the specified types.

Specified by:
purgeAllBut in interface AttributeContainer
Parameters:
attrTypeIds - The attribute types to be retained.

replaceContent

public void replaceContent(AttributeContainer newContent)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
replaceContent in interface AttributeContainer
Parameters:
newContent -

addContentChangedListener

public void addContentChangedListener(ContentChangedListener listener)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
addContentChangedListener in interface AttributeContainer
Parameters:
listener -

removeContentChangedListener

public void removeContentChangedListener(ContentChangedListener listener)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
removeContentChangedListener in interface AttributeContainer
Parameters:
listener -

getConstraintContainer

public ConstraintContainer getConstraintContainer()
Returns the constraint container associated with this instance.

Specified by:
getConstraintContainer in interface AttributeContainer
Returns:
The constraint container, or null if no constraint container is associated.

setConstraintContainer

public void setConstraintContainer(ConstraintContainer container)
Sets the constraint container associated with this instance.

Specified by:
setConstraintContainer in interface AttributeContainer
Parameters:
container - The new constraint container.

getDescriptorContainer

public DescriptorContainer getDescriptorContainer()
Returns the descriptor container associated with this instance.

Specified by:
getDescriptorContainer in interface AttributeContainer
Returns:
The descriptor container, or null if no constraint container is associated.

setDescriptorContainer

public void setDescriptorContainer(DescriptorContainer container)
Sets the descriptor container associated with this instance.

Specified by:
setDescriptorContainer in interface AttributeContainer
Parameters:
container - The new descriptor container.

toString

public String toString()

getAtt

public IeAtt getAtt(AttributeTypeIdentifier attrTypeId)
Returns an attribute by attribute type identifier.

Parameters:
attrTypeId - The attribute type identifier.
Returns:
The matching attribute, or null if no attribute has the specified identifier.

getDatum

public IeDatum getDatum(AttributeIdentifier attrId)
Returns an attribute value by attribute identifier.

Parameters:
attrId - The attribute identifier.
Returns:
The matching attribute, or null if no attribute has the specified identifier.

addDatum

public void addDatum(IeDatum datum)
Adds an attribute value by attribute identifier.

Parameters:
datum - The attribute value. If the attribute value does not contain an attribute identifier, it is not added.

removeDatum

public void removeDatum(IeDatum datum)
Removes an attribute value by attribute identifier.

Parameters:
datum - The attribute value. If the attribute value does not contain an attribute identifier, nothing is removed.

removeDatum

public void removeDatum(AttributeIdentifier attrId)
Removes an attribute value by attribute identifier.

Parameters:
attrId - The attribute identifier of the value to be removed.

getContent

public Object getContent(AttributeIdentifier attrId)
Returns the content associated with an attribute specified by attribute identifier. If the attribute is multivalued, the first value is returned.

Parameters:
attrId - The attribute identifier of the attribute for which to return content.
Returns:
The content, or null if the attribute identifier does not match any attributes in this instance, or the attribute has no content.

contains

public boolean contains(AttributeIdentifier attrId)
Returns true if this instance contains an attribute specified by AttributeIdentifier.

Parameters:
attrId - The attribute identifier.
Returns:
true if this instance contains the specified attribute

getFti

public String getFti()
Returns the federated type identifier of this node.

Returns:
The federated type identifier.

setFti

public void setFti(String fti)
Sets the federated type identifier of this node.

Parameters:
fti - The new federated type identifier.

getUfid

public String getUfid()
Returns the unique federation identifier of this node.

Returns:
The unique federation identifier.

setUfid

public void setUfid(String ufid)
Sets the unique federation identifier of this node.

Parameters:
ufid - The new unique federation identifier.

_put

private AttributeIdentifier _put(AttributeIdentifier attrId,
                                 Object content,
                                 State state)
                          throws IllegalContentException,
                                 ConstraintException
Puts a specified attribute, with state, into this instance.

Throws:
IllegalContentException
ConstraintException

_remove

private void _remove(AttributeTypeIdentifier attrTypeId,
                     IeDatum datum)
              throws ConstraintException
Throws:
ConstraintException

_getKeyFrom

private Object _getKeyFrom(HashMap map,
                           Object oldKey)

_expandTypeInstanceIdentifier

private Vector _expandTypeInstanceIdentifier(TypeInstanceIdentifier id)

_hasInContext

private boolean _hasInContext(AttributeIdentifier attrId,
                              AssociationIdentifier associationId)

_hasInContext

private boolean _hasInContext(AttributeTypeIdentifier attrTypeId,
                              AssociationTypeIdentifier associationTypeId)

_merge

private void _merge(AttributeContainer container,
                    AttributeIdentifier[] aids,
                    AttributeIdentifier[] otherAids)

clone

public AttributeContainer clone(AttributeTypeIdentifier[] filter,
                                boolean compact)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
clone in interface AttributeContainer
Parameters:
filter -
compact -
Returns:
AttributeContainer

cloneWithNewUninitializedIdentifiers

public AttributeContainer cloneWithNewUninitializedIdentifiers(HashMap map)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
cloneWithNewUninitializedIdentifiers in interface AttributeContainer
Parameters:
map -
Returns:
AttributeContainer

extractCopy

public AttributeContainer extractCopy(TypeInstanceIdentifier the_type_instance_identifier,
                                      AttributeTypeIdentifier[] filter,
                                      boolean compact)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
extractCopy in interface AttributeContainer
Parameters:
the_type_instance_identifier -
filter -
compact -
Returns:
AttributeContainer

replace

public void replace(TypeInstanceIdentifier old_id,
                    TypeInstanceIdentifier new_id)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
replace in interface AttributeContainer
Parameters:
old_id -
new_id -

addReplacement

public void addReplacement(ElementIdentifier old_id,
                           ElementIdentifier new_id)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
addReplacement in interface AttributeContainer
Parameters:
old_id -
new_id -

getReplacements

public HashMap getReplacements()
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
getReplacements in interface AttributeContainer
Returns:
HashMap

clearReplacements

public void clearReplacements()
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
clearReplacements in interface AttributeContainer

getInternal

public Object getInternal(AttributeIdentifier the_attribute_identifier)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
getInternal in interface AttributeContainer
Parameters:
the_attribute_identifier -
Returns:
Object

getIdentifier

public ElementIdentifier getIdentifier()
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
getIdentifier in interface AttributeContainer
Returns:
ElementIdentifier

put

public AttributeIdentifier put(AttributeIdentifier the_attribute_identifier,
                               Object the_content,
                               ConstraintContainer the_constraint_container)
                        throws IllegalContentException,
                               ConstraintException
Description copied from interface: AttributeContainer
Stores the given content in this container, in assocation with the given AttributeIdentifier. If the given AttributeIdentifier does not already exist in the container, and the given content is null, then the state associated with the given AttributeIdentifier is set to State.UNINTIALIZED. If the given AttributeIdentifier does not already exist in the container, and the given content is not null, then the state associated with the given AttributeIdentifier is set to State.New. If the given AttributeIdentifier already exists in the container and the previous state associated with the given AttributeIdentifier was State.UNINTIALIZED, the associated state becomes State.NEW. If the given AttributeIdentifier already exists in the container and the previous state associated with the given AttributeIdentifier was State.UNCHANGED, the associated state becomes State.CHANGED. If the given AttributeIdentifier already exists in the container and the previous state associated with the given AttributeIdentifier was State.DELETED, the associated state becomes State.CHANGED. If the given AttributeIdentifier already exists in the container and the previous state associated with the given AttributeIdentifier was State.DEFAULT, the associated state becomes State.NEW. Returns the actual Attributeidentifier used to store the content. This will be different from the given AttributeIdentifier in the case where the previous state associated with the given AttributeIdentifier was State.DEFAULT and in the case where equivalent AttributeIdentifier(s) may already be present in the AttributeContainer. In all cases, the returned AttributeIdentifier represents the most accurate and efficient AttributeIdentifier to be used for future access to the stored content. Throws IllegalContentException if the content is an AttributeContainerFunction and the function is recursive. (The function has the given AttributeIdentifier or the AttributeTypeIdentifier corresponding to the given AttributeIdentifier as one of its arguments.) Throws ConstraintException if adding/changing the given content violates one or more of the constraints in the associated ConstraintContainer.

Supported API: true

Specified by:
put in interface AttributeContainer
Parameters:
the_attribute_identifier -
the_content -
the_constraint_container -
Returns:
AttributeIdentifier
Throws:
ConstraintException
IllegalContentException

remove

public void remove(AttributeIdentifier the_attribute_identifier,
                   ConstraintContainer the_constraint_container)
            throws ConstraintException
Description copied from interface: AttributeContainer
Deletes the content associated with the given AttributeIdentifier from this container. If the previous state associated with the given AttributeIdentifier was State.UNINTIALIZED or State.NEW, the given AttributeIdentifier and associated content are removed from the container. If the previous state associated with the given AttributeIdentifier was State.UNCHANGED or State.CHANGED, the associated state becomes State.DELETED. Throws ConstraintException if deleting the associated content violates one or more of the constraints in the associated ConstraintContainer.

Supported API: true

Specified by:
remove in interface AttributeContainer
Parameters:
the_attribute_identifier -
the_constraint_container -
Throws:
ConstraintException

remove

public void remove(AttributeTypeIdentifier the_attribute_type_identifier,
                   ConstraintContainer the_constraint_container)
            throws ConstraintException
Description copied from interface: AttributeContainer
Deletes the content associated with all AttributeIdentifiers associated with the given AttributeTypeIdentifier from this container. If the previous state associated with one of the AttributeIdentifiers was State.UNINTIALIZED or State.NEW, the AttributeIdentifier and associated content are removed from the container. If the previous state associated with one of the AttributeIdentifiers was State.UNCHANGED or State.CHANGED, the associated state becomes State.DELETED. Throws ConstraintException if deleting any of the associaited content violates one or more of the constraints in the associated ConstraintContainer.

Supported API: true

Specified by:
remove in interface AttributeContainer
Parameters:
the_attribute_type_identifier -
the_constraint_container -
Throws:
ConstraintException

getAttributeTypeSummary

public AttributeTypeSummary getAttributeTypeSummary(AttributeTypeIdentifier the_attribute_type_identifier,
                                                    ConstraintContainer the_constraint_container,
                                                    DescriptorContainer the_descriptor_container)
Description copied from interface: AttributeContainer
Returns an AttributeTypeSummary for the AttributeTypeIdentifier.

Supported API: true

Specified by:
getAttributeTypeSummary in interface AttributeContainer
Parameters:
the_attribute_type_identifier -
the_constraint_container -
the_descriptor_container -
Returns:
AttributeTypeSummary

getAttributeTypeSummary

public AttributeTypeSummary getAttributeTypeSummary(AssociationIdentifier the_association_identifier,
                                                    AttributeTypeIdentifier the_attribute_type_identifier,
                                                    boolean is_absolute)
Description copied from interface: AttributeContainer
Returns an AttributeTypeSummary for the AttributeTypeIdentifier.

Supported API: true

Specified by:
getAttributeTypeSummary in interface AttributeContainer
Parameters:
the_association_identifier -
the_attribute_type_identifier -
is_absolute -
Returns:
AttributeTypeSummary

getAttributeTypeSummary

public AttributeTypeSummary getAttributeTypeSummary(AssociationIdentifier the_association_identifier,
                                                    AttributeTypeIdentifier the_attribute_type_identifier,
                                                    boolean is_absolute,
                                                    ConstraintContainer the_constraint_container,
                                                    DescriptorContainer the_descriptor_container)
Description copied from interface: AttributeContainer
Returns an AttributeTypeSummary for the AttributeTypeIdentifier.

Supported API: true

Specified by:
getAttributeTypeSummary in interface AttributeContainer
Parameters:
the_association_identifier -
the_attribute_type_identifier -
is_absolute -
the_constraint_container -
the_descriptor_container -
Returns:
AttributeTypeSummary

acceptChanges

public void acceptChanges()
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
acceptChanges in interface AttributeContainer

setState

public void setState(AttributeIdentifier the_attribute_identifier,
                     State the_state)
Description copied from interface: AttributeContainer
Sets the state associated with the given AttributeIdentifier in this container. Has no effect if the AttributeIdentifier is not in the container.

Supported API: true

Specified by:
setState in interface AttributeContainer
Parameters:
the_attribute_identifier -
the_state -

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(TypeInstanceIdentifier the_type_instance_identifier)
Description copied from interface: AttributeContainer
Returns all current AttributeIdentifiers in this container defined directly in the context of the given TypeInstanceIdentifier. (Does not include AttributeIdentifiers for which the state is State.DELETED.) (Does not include AttributeIdentifiers for which the state is State.DEFAULT, unless there are no other AttributeIdentifiers in the container defined directly in the context of the given TypeInstanceIdentifier with matching AttributeTypeIdentifiersfor which the state is not State.DEFAULT or State.DELETED.) Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
the_type_instance_identifier -
Returns:
AttributeIdentifier[]

getAttributeIdentifiers

public AttributeIdentifier[] getAttributeIdentifiers(TypeInstanceIdentifier the_type_instance_identifier,
                                                     State the_state)
Description copied from interface: AttributeContainer
Returns all AttributeIdentifiers in this container defined directly in the context of the given TypeInstanceIdentifier that match the given state. If the given state is null, returns all AttributeIdentifiers in this container defined directly in the context of the given TypeInstanceIdentifier. Returns an empty array if no matches are found.

Supported API: true

Specified by:
getAttributeIdentifiers in interface AttributeContainer
Parameters:
the_type_instance_identifier -
the_state -
Returns:
AttributeIdentifier[]

purge

public void purge(TypeInstanceIdentifier[] the_type_instance_identifiers)
Description copied from interface: AttributeContainer


Supported API: false

Specified by:
purge in interface AttributeContainer
Parameters:
the_type_instance_identifiers -