com.infoengine.object
Class IeNode

java.lang.Object
  com.infoengine.object.IeObject
      com.infoengine.object.IeNode

All Implemented Interfaces:

com.ptc.core.meta.container.common.AttributeContainer, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class IeNode
extends IeObject
implements com.ptc.core.meta.container.common.AttributeContainer, java.io.Externalizable, java.lang.Cloneable

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_KEY
static java.lang.String	FTI_KEY
static java.lang.String	OBID_KEY

Constructor Summary

IeNode()
Constructs a new IeNode

IeNode(com.ptc.core.meta.container.common.AttributeContainer container)
Constructs a new IeNode from a generic AttributeContainer.

IeNode(java.util.HashMap contentMap, java.util.HashMap stateMap)
Constructs a new IeNode from a content map and a state map that are both keyed by AttributeIdentifier.

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

Method Summary

void	acceptChanges()
void	acceptDefaultContent() Modifies all attribute values whose content is in the DEFAULT state such that their state is NEW.
void	addContentChangedListener(com.ptc.core.meta.container.common.ContentChangedListener listener)
void	addDatum(IeDatum datum) Adds an attribute value by attribute identifier.
void	addNode(IeNode node) Adds a child node to the node.
void	addReplacement(com.ptc.core.meta.common.ElementIdentifier old_id, com.ptc.core.meta.common.ElementIdentifier new_id)
void	clearReplacements()
com.ptc.core.meta.container.common.AttributeContainer	clone(com.ptc.core.meta.common.AttributeTypeIdentifier[] filter, boolean compact)
com.ptc.core.meta.container.common.AttributeContainer	clone(boolean compact)
com.ptc.core.meta.container.common.AttributeContainer	cloneWithNewCenter(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)
com.ptc.core.meta.container.common.AttributeContainer	cloneWithNewUninitializedIdentifiers(java.util.HashMap map)
boolean	contains(com.ptc.core.meta.common.AttributeIdentifier attrId) Returns true if this instance contains an attribute specified by AttributeIdentifier.
boolean	containsTii(com.ptc.core.meta.common.TypeInstanceIdentifier tii)
com.ptc.core.meta.container.common.AttributeContainer[]	decompose(boolean compact)
java.lang.Object	deepClone() Returns a deep copy of the node.
com.ptc.core.meta.container.common.AttributeContainer[]	extract(com.ptc.core.meta.common.TypeIdentifier typeId)
com.ptc.core.meta.container.common.AttributeContainer[]	extract(com.ptc.core.meta.common.TypeIdentifier typeId, boolean navigate)
com.ptc.core.meta.container.common.AttributeContainer	extract(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)
com.ptc.core.meta.container.common.AttributeContainer	extract(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId, boolean navigate)
com.ptc.core.meta.container.common.AttributeContainer[]	extractCopies(com.ptc.core.meta.common.TypeIdentifier typeId, boolean navigate, boolean compact)
com.ptc.core.meta.container.common.AttributeContainer	extractCopy(com.ptc.core.meta.common.TypeInstanceIdentifier the_type_instance_identifier, com.ptc.core.meta.common.AttributeTypeIdentifier[] filter, boolean compact)
com.ptc.core.meta.container.common.AttributeContainer	extractCopy(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId, boolean navigate, boolean compact)
java.lang.Object	get(com.ptc.core.meta.common.AttributeIdentifier attrId) Get the content associated with this AttributeIdentifier.
java.lang.Object	get(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId) Get the content associated with this AttributeTypeIdentifier.
com.ptc.core.meta.common.AssociationIdentifier[]	getAssociationIdentifiers(com.ptc.core.meta.common.TypeIdentifier typeId) Returns all association identifiers for attributes in the contains that match a specific type identifier.
com.ptc.core.meta.common.AssociationIdentifier[]	getAssociationIdentifiers(com.ptc.core.meta.common.TypeIdentifier typeId, com.ptc.core.meta.container.common.State state) Returns all association identifiers for attributes in the container that match a specific type identifier and state.
com.ptc.core.meta.common.AssociationIdentifier[]	getAssociationIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)
com.ptc.core.meta.common.AssociationIdentifier[]	getAssociationIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId, com.ptc.core.meta.container.common.State state)
IeAtt	getAtt(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId) Returns an attribute by attribute type identifier.
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers() Returns all AttributeIdentifiers from this container.
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId) Returns attribute identifiers of all attributes from the container that have a specific association identifier in their context.
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId, com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId, boolean isAbsolute)
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId, com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId, boolean isAbsolute, com.ptc.core.meta.container.common.State state)
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId, com.ptc.core.meta.container.common.State state)
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId) Returns all attribute identifiers from this container associated with a specific attribute type identifier.
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId, com.ptc.core.meta.container.common.State state) Returns all attribute identifiers of attributes from this container that match a specific attribute type identifier and attribute state.
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.container.common.State state) Returns all attribute identifiers of attribute values having a specific state.
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(java.lang.String logicalForm)
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier the_type_instance_identifier)
com.ptc.core.meta.common.AttributeIdentifier[]	getAttributeIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier the_type_instance_identifier, com.ptc.core.meta.container.common.State the_state)
com.ptc.core.meta.common.AttributeTypeIdentifier[]	getAttributeTypeIdentifiers() Returns all unique AttributeTypeIdentifiers from this container.
com.ptc.core.meta.common.AttributeTypeIdentifier[]	getAttributeTypeIdentifiers(java.lang.String logicalForm)
com.ptc.core.meta.container.common.AttributeTypeSummary	getAttributeTypeSummary(com.ptc.core.meta.common.AssociationIdentifier the_association_identifier, com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier, boolean is_absolute)
com.ptc.core.meta.container.common.AttributeTypeSummary	getAttributeTypeSummary(com.ptc.core.meta.common.AssociationIdentifier the_association_identifier, com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier, boolean is_absolute, com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container, com.ptc.core.meta.container.common.DescriptorContainer the_descriptor_container)
com.ptc.core.meta.container.common.AttributeTypeSummary	getAttributeTypeSummary(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId) Retrieves the AttributeTypeSummary for the AttributeTypeIdentifier.
com.ptc.core.meta.container.common.AttributeTypeSummary	getAttributeTypeSummary(com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier, com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container, com.ptc.core.meta.container.common.DescriptorContainer the_descriptor_container)
com.ptc.core.meta.container.common.AttributeTypeSummary	getAttributeTypeSummary(java.lang.String name) Retrieves the AttributeTypeSummary for the attribute specified by logical identifier.
com.ptc.core.meta.container.common.ConstraintContainer	getConstraintContainer() Returns the constraint container associated with this instance.
java.lang.Object	getContent(com.ptc.core.meta.common.AttributeIdentifier attrId) Returns the content associated with an attribute specified by attribute identifier.
IeDatum	getDatum(com.ptc.core.meta.common.AttributeIdentifier attrId) Returns an attribute value by attribute identifier.
com.ptc.core.meta.descriptor.common.DefinitionDescriptor	getDescriptor(com.ptc.core.meta.common.DefinitionIdentifier defnId) Get the descriptor for this DefinitionIdentifier.
com.ptc.core.meta.container.common.DescriptorContainer	getDescriptorContainer() Returns the descriptor container associated with this instance.
java.lang.String	getFti() Returns the federated type identifier of this node.
com.ptc.core.meta.common.ElementIdentifier	getIdentifier()
java.lang.Object	getInternal(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier)
IeNode	getNode(java.lang.String name) Returns a child node by name.
java.lang.String	getNodeName() Returns the DOM node name of this object.
java.util.Enumeration	getNodes() Returns all of the child nodes of the node.
java.util.HashMap	getReplacements()
java.lang.Object	getSingle(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId) Get the single content associated with this AttributeTypeIdentifier.
java.lang.Object	getSingle(java.lang.String logicalForm)
com.ptc.core.meta.container.common.State	getState(com.ptc.core.meta.common.AttributeIdentifier attrId) Returns the state of the content associated with a specific attribute identifier.
java.lang.String	getUfid() Returns the unique federation identifier of this node.
boolean	isContentOfState(com.ptc.core.meta.common.AttributeIdentifier attrId, com.ptc.core.meta.container.common.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(com.ptc.core.meta.container.common.AttributeContainer container) Combines the content of another container with this one.
void	merge(com.ptc.core.meta.container.common.AttributeContainer container, com.ptc.core.meta.common.AssociationIdentifier relationship)
void	merge(com.ptc.core.meta.container.common.AttributeContainer container, com.ptc.core.meta.common.AssociationIdentifier relationship, boolean containerHasPriority)
void	merge(com.ptc.core.meta.container.common.AttributeContainer container, boolean containerHasPriority)
void	purge(com.ptc.core.meta.common.AttributeIdentifier attrId)
void	purge(com.ptc.core.meta.common.AttributeIdentifier[] ais_to_purge)
void	purge(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId)
void	purge(com.ptc.core.meta.common.TypeIdentifier typeId)
void	purge(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)
void	purge(com.ptc.core.meta.common.TypeInstanceIdentifier[] the_type_instance_identifiers)
void	purge(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId, com.ptc.core.meta.common.TypeInstanceIdentifier[] preserve)
void	purgeAllBut(com.ptc.core.meta.common.AttributeTypeIdentifier[] attrTypeIds) Removes all attributes except ones with the specified types.
void	purgeAllContent()
void	purgeDefaultContent() Removes all content that is considered DEFAULT.
void	purgeDuplicateContent()
void	purgeNonDirtyContent() Removes all content who's state is DEFAULT, UNCHANGED, or UNINITIALIZED.
com.ptc.core.meta.common.AttributeIdentifier	put(com.ptc.core.meta.common.AttributeIdentifier attrId, java.lang.Object content) Store this content and associate it with this AttributeIdentifier in the container.
com.ptc.core.meta.common.AttributeIdentifier	put(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier, java.lang.Object the_content, com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container)
void	readExternal(java.io.ObjectInput in)
void	remove(com.ptc.core.meta.common.AttributeIdentifier attrId) Remove this AttributeIdentifier and it's content from the container.
void	remove(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier, com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container)
void	remove(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId) Remove all AttributeIdentifiers, and their content, that have this AttributeTypeIdentifier.
void	remove(com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier, com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container)
void	removeAllNodes() Removes all of the child nodes associated with the node.
void	removeContentChangedListener(com.ptc.core.meta.container.common.ContentChangedListener listener)
void	removeDatum(com.ptc.core.meta.common.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(java.util.HashMap id_map)
void	replace(com.ptc.core.meta.common.TypeInstanceIdentifier old_id, com.ptc.core.meta.common.TypeInstanceIdentifier new_id)
void	replaceContent(com.ptc.core.meta.container.common.AttributeContainer newContent)
void	setConstraintContainer(com.ptc.core.meta.container.common.ConstraintContainer container) Sets the constraint container associated with this instance.
void	setDescriptorContainer(com.ptc.core.meta.container.common.DescriptorContainer container) Sets the descriptor container associated with this instance.
void	setFti(java.lang.String fti) Sets the federated type identifier of this node.
void	setState(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier, com.ptc.core.meta.container.common.State the_state)
void	setUfid(java.lang.String ufid) Sets the unique federation identifier of this node.
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class com.infoengine.object.IeObject

addAtt, addMeta, addMeta, addMeta, addMeta, addMetaDatum, addMetaValue, addMetaValues, appendMetaDatum, canonicalize, canonicalize, clone, containsMetaValue, deepCopy, firstAtt, firstChild, firstMetaValue, getAtt, getAttAt, getAttByMeta, getAttCount, getAttribute, getAtts, getChildCount, getChildren, getHasChanged, getMeta, getMetaNames, getMetaValue, getMetaValueAt, getMetaValueCount, getMetaValues, getName, getTagName, getType, hasChildren, indexOfMetaValue, lastAtt, lastChild, lastMetaValue, removeAllAtts, removeAllMeta, removeAllMetaValues, removeAtt, removeAtt, removeAttAt, removeAttribute, removeChild, removeMeta, removeMetaValue, removeMetaValueAt, removeName, removeType, replaceChild, setAttAt, setAttribute, setHasChanged, setMeta, setMeta, setMeta, setMeta, setMetaValue, setMetaValueAt, setName, setType, shallowCopy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ptc.core.meta.container.common.AttributeContainer

clone

Field Detail

CLASS_KEY

public static final java.lang.String CLASS_KEY

See Also:

Constant Field Values

FTI_KEY

public static final java.lang.String FTI_KEY

See Also:

Constant Field Values

OBID_KEY

public static final java.lang.String OBID_KEY

See Also:

Constant Field Values

Constructor Detail

IeNode

public IeNode()

Constructs a new IeNode

IeNode

public IeNode(java.lang.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(com.ptc.core.meta.container.common.AttributeContainer container)

Constructs a new IeNode from a generic AttributeContainer.

Parameters:

container - The AttributeContainer instance from which to construct this IeNode

IeNode

public IeNode(java.util.HashMap contentMap,
              java.util.HashMap stateMap)
       throws com.ptc.core.meta.container.common.IllegalContentException,
              com.ptc.core.meta.container.common.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

Throws:

com.ptc.core.meta.container.common.IllegalContentException

com.ptc.core.meta.container.common.ConstraintException

Method Detail

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class IeObject

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class IeObject

Throws:

java.io.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(java.lang.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 java.util.Enumeration getNodes()

Returns all of the child nodes of the node.

Returns:

The children

getNodeName

public java.lang.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 java.lang.Object deepClone()

Returns a deep copy of the node.

Overrides:

deepClone in class IeObject

Returns:

The deep copy

getAttributeTypeIdentifiers

public com.ptc.core.meta.common.AttributeTypeIdentifier[] getAttributeTypeIdentifiers()

Returns all unique AttributeTypeIdentifiers from this container.

Specified by:

getAttributeTypeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Returns:

AttributeTypeIdentifier[]

getAttributeTypeIdentifiers

public com.ptc.core.meta.common.AttributeTypeIdentifier[] getAttributeTypeIdentifiers(java.lang.String logicalForm)

Specified by:

getAttributeTypeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

logicalForm -

Returns:

AttributeTypeIdentifier[]

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers()

Returns all AttributeIdentifiers from this container.

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Returns:

AttributeIdentifier[]

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.container.common.State state)

Returns all attribute identifiers of attribute values having a specific state.

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

state - The state of attribute values for which to return identifiers.

Returns:

The matching attribute identifiers.

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId)

Returns all attribute identifiers from this container associated with a specific attribute type identifier.

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrTypeId - The attribute type identifier to be matched.

Returns:

The attribute identifiers associated with the attribute type identifier.

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId,
                                                                              com.ptc.core.meta.container.common.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 com.ptc.core.meta.container.common.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 com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.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 com.ptc.core.meta.container.common.AttributeContainer

Parameters:

associationId - The association identifier.

Returns:

The matching attribute identifiers.

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId,
                                                                              com.ptc.core.meta.container.common.State state)

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

associationId - The association identifier.

state - The state of attributes to match.

Returns:

The identifiers of matching attributes.

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId,
                                                                              com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId,
                                                                              boolean isAbsolute)

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

associationId - The association identifier.

attrTypeId - The attribute type identifier to match.

isAbsolute -

Returns:

The identifiers of matching attributes.

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.AssociationIdentifier associationId,
                                                                              com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId,
                                                                              boolean isAbsolute,
                                                                              com.ptc.core.meta.container.common.State state)

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.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 com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(java.lang.String logicalForm)

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

logicalForm -

Returns:

AttributeIdentifier[]

getAssociationIdentifiers

public com.ptc.core.meta.common.AssociationIdentifier[] getAssociationIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)

Specified by:

getAssociationIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId - The type instance identifier.

Returns:

The identifiers of matching attributes.

getAssociationIdentifiers

public com.ptc.core.meta.common.AssociationIdentifier[] getAssociationIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId,
                                                                                  com.ptc.core.meta.container.common.State state)

Specified by:

getAssociationIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

state -

Returns:

The association identifiers

getAssociationIdentifiers

public com.ptc.core.meta.common.AssociationIdentifier[] getAssociationIdentifiers(com.ptc.core.meta.common.TypeIdentifier typeId)

Returns all association identifiers for attributes in the contains that match a specific type identifier.

Specified by:

getAssociationIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeId - The type identifier.

Returns:

The association identifiers.

getAssociationIdentifiers

public com.ptc.core.meta.common.AssociationIdentifier[] getAssociationIdentifiers(com.ptc.core.meta.common.TypeIdentifier typeId,
                                                                                  com.ptc.core.meta.container.common.State state)

Returns all association identifiers for attributes in the container that match a specific type identifier and state.

Specified by:

getAssociationIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeId - The type identifier.

state - The state to match.

Returns:

The association identifiers.

get

public java.lang.Object get(com.ptc.core.meta.common.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 com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrId - The identifier of the attribute to return.

Returns:

The content.

get

public java.lang.Object get(com.ptc.core.meta.common.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 com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrTypeId - The attribute type identifier.

Returns:

The value(s)

getSingle

public java.lang.Object getSingle(com.ptc.core.meta.common.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 com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrTypeId - The attribute type identifier.

Returns:

The single object.

getSingle

public java.lang.Object getSingle(java.lang.String logicalForm)

Specified by:

getSingle in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

logicalForm -

Returns:

Object

put

public com.ptc.core.meta.common.AttributeIdentifier put(com.ptc.core.meta.common.AttributeIdentifier attrId,
                                                        java.lang.Object content)
                                                 throws com.ptc.core.meta.container.common.IllegalContentException,
                                                        com.ptc.core.meta.container.common.ConstraintException

Store this content and associate it with this AttributeIdentifier in the container.

Specified by:

put in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrId - The attribute identifier

content - The content

Returns:

The attribute identifier

Throws:

com.ptc.core.meta.container.common.IllegalContentException

com.ptc.core.meta.container.common.ConstraintException

remove

public void remove(com.ptc.core.meta.common.AttributeIdentifier attrId)
            throws com.ptc.core.meta.container.common.ConstraintException

Remove this AttributeIdentifier and it's content from the container.

Specified by:

remove in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrId - The identifier of the attribute to be removed.

Throws:

com.ptc.core.meta.container.common.ConstraintException

remove

public void remove(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId)
            throws com.ptc.core.meta.container.common.ConstraintException

Remove all AttributeIdentifiers, and their content, that have this AttributeTypeIdentifier.

Specified by:

remove in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrTypeId - The attribute type identifier.

Throws:

com.ptc.core.meta.container.common.ConstraintException

getDescriptor

public com.ptc.core.meta.descriptor.common.DefinitionDescriptor getDescriptor(com.ptc.core.meta.common.DefinitionIdentifier defnId)

Get the descriptor for this DefinitionIdentifier. If there's no DescriptorContainer associated, return null.

Specified by:

getDescriptor in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

defnId - The definition identifier

Returns:

The definition descriptor, if any

getAttributeTypeSummary

public com.ptc.core.meta.container.common.AttributeTypeSummary getAttributeTypeSummary(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId)

Retrieves the AttributeTypeSummary for the AttributeTypeIdentifier.

Specified by:

getAttributeTypeSummary in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrTypeId - The attribute type identifier

Returns:

The attribute summary

getAttributeTypeSummary

public com.ptc.core.meta.container.common.AttributeTypeSummary getAttributeTypeSummary(java.lang.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 com.ptc.core.meta.container.common.AttributeContainer

Returns:

true if the container is dirty

isContentOfState

public boolean isContentOfState(com.ptc.core.meta.common.AttributeIdentifier attrId,
                                com.ptc.core.meta.container.common.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 com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrId - The attribute identifier

state - The state

Returns:

true if the content is in the specified state

getState

public com.ptc.core.meta.container.common.State getState(com.ptc.core.meta.common.AttributeIdentifier attrId)

Returns the state of the content associated with a specific attribute identifier.

Specified by:

getState in interface com.ptc.core.meta.container.common.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 com.ptc.core.meta.container.common.AttributeContainer

decompose

public com.ptc.core.meta.container.common.AttributeContainer[] decompose(boolean compact)

Specified by:

decompose in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

compact -

Returns:

AttributeContainer[]

clone

public com.ptc.core.meta.container.common.AttributeContainer clone(boolean compact)

Specified by:

clone in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

compact -

Returns:

AttributeContainer

cloneWithNewCenter

public com.ptc.core.meta.container.common.AttributeContainer cloneWithNewCenter(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)

Specified by:

cloneWithNewCenter in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

Returns:

AttributeContainer

merge

public void merge(com.ptc.core.meta.container.common.AttributeContainer container)

Combines the content of another container with this one.

Specified by:

merge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

container - The container to be merged with this one.

merge

public void merge(com.ptc.core.meta.container.common.AttributeContainer container,
                  com.ptc.core.meta.common.AssociationIdentifier relationship)

Specified by:

merge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

container -

relationship -

merge

public void merge(com.ptc.core.meta.container.common.AttributeContainer container,
                  boolean containerHasPriority)

Specified by:

merge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

container -

containerHasPriority -

merge

public void merge(com.ptc.core.meta.container.common.AttributeContainer container,
                  com.ptc.core.meta.common.AssociationIdentifier relationship,
                  boolean containerHasPriority)

Specified by:

merge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

container -

relationship -

containerHasPriority -

extract

public com.ptc.core.meta.container.common.AttributeContainer extract(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)

Specified by:

extract in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

Returns:

AttributeContainer

extract

public com.ptc.core.meta.container.common.AttributeContainer[] extract(com.ptc.core.meta.common.TypeIdentifier typeId)

Specified by:

extract in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeId -

Returns:

AttributeContainer[]

extract

public com.ptc.core.meta.container.common.AttributeContainer extract(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId,
                                                                     boolean navigate)

Specified by:

extract in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

navigate -

Returns:

AttributeContainer

extractCopy

public com.ptc.core.meta.container.common.AttributeContainer extractCopy(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId,
                                                                         boolean navigate,
                                                                         boolean compact)

Specified by:

extractCopy in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

navigate -

compact -

Returns:

AttributeContainer

extractCopies

public com.ptc.core.meta.container.common.AttributeContainer[] extractCopies(com.ptc.core.meta.common.TypeIdentifier typeId,
                                                                             boolean navigate,
                                                                             boolean compact)

Specified by:

extractCopies in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeId -

navigate -

compact -

Returns:

AttributeContainer[]

extract

public com.ptc.core.meta.container.common.AttributeContainer[] extract(com.ptc.core.meta.common.TypeIdentifier typeId,
                                                                       boolean navigate)

Specified by:

extract in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeId -

navigate -

Returns:

AttributeContainer[]

purge

public void purge(com.ptc.core.meta.common.AttributeIdentifier attrId)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrId -

purge

public void purge(com.ptc.core.meta.common.AttributeTypeIdentifier attrTypeId)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attributeTypeId -

purge

public void purge(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

purge

public void purge(com.ptc.core.meta.common.TypeIdentifier typeId)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeId -

purge

public void purge(com.ptc.core.meta.common.TypeInstanceIdentifier typeInstanceId,
                  com.ptc.core.meta.common.TypeInstanceIdentifier[] preserve)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

typeInstanceId -

preserve -

purgeDefaultContent

public void purgeDefaultContent()

Removes all content that is considered DEFAULT.

Specified by:

purgeDefaultContent in interface com.ptc.core.meta.container.common.AttributeContainer

purgeNonDirtyContent

public void purgeNonDirtyContent()

Removes all content who's state is DEFAULT, UNCHANGED, or UNINITIALIZED.

Specified by:

purgeNonDirtyContent in interface com.ptc.core.meta.container.common.AttributeContainer

purgeDuplicateContent

public void purgeDuplicateContent()

Specified by:

purgeDuplicateContent in interface com.ptc.core.meta.container.common.AttributeContainer

purgeAllContent

public void purgeAllContent()

Specified by:

purgeAllContent in interface com.ptc.core.meta.container.common.AttributeContainer

purgeAllBut

public void purgeAllBut(com.ptc.core.meta.common.AttributeTypeIdentifier[] attrTypeIds)

Removes all attributes except ones with the specified types.

Specified by:

purgeAllBut in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

attrTypeIds - The attribute types to be retained.

replaceContent

public void replaceContent(com.ptc.core.meta.container.common.AttributeContainer newContent)

Specified by:

replaceContent in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

newContent -

addContentChangedListener

public void addContentChangedListener(com.ptc.core.meta.container.common.ContentChangedListener listener)

Specified by:

addContentChangedListener in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

listener -

removeContentChangedListener

public void removeContentChangedListener(com.ptc.core.meta.container.common.ContentChangedListener listener)

Specified by:

removeContentChangedListener in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

listener -

getConstraintContainer

public com.ptc.core.meta.container.common.ConstraintContainer getConstraintContainer()

Returns the constraint container associated with this instance.

Specified by:

getConstraintContainer in interface com.ptc.core.meta.container.common.AttributeContainer

Returns:

The constraint container, or null if no constraint container is associated.

setConstraintContainer

public void setConstraintContainer(com.ptc.core.meta.container.common.ConstraintContainer container)

Sets the constraint container associated with this instance.

Specified by:

setConstraintContainer in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

container - The new constraint container.

getDescriptorContainer

public com.ptc.core.meta.container.common.DescriptorContainer getDescriptorContainer()

Returns the descriptor container associated with this instance.

Specified by:

getDescriptorContainer in interface com.ptc.core.meta.container.common.AttributeContainer

Returns:

The descriptor container, or null if no constraint container is associated.

setDescriptorContainer

public void setDescriptorContainer(com.ptc.core.meta.container.common.DescriptorContainer container)

Sets the descriptor container associated with this instance.

Specified by:

setDescriptorContainer in interface com.ptc.core.meta.container.common.AttributeContainer

Parameters:

container - The new descriptor container.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAtt

public IeAtt getAtt(com.ptc.core.meta.common.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(com.ptc.core.meta.common.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(com.ptc.core.meta.common.AttributeIdentifier attrId)

Removes an attribute value by attribute identifier.

Parameters:

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

getContent

public java.lang.Object getContent(com.ptc.core.meta.common.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(com.ptc.core.meta.common.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 java.lang.String getFti()

Returns the federated type identifier of this node.

Returns:

The federated type identifier.

setFti

public void setFti(java.lang.String fti)

Sets the federated type identifier of this node.

Parameters:

fti - The new federated type identifier.

getUfid

public java.lang.String getUfid()

Returns the unique federation identifier of this node.

Returns:

The unique federation identifier.

setUfid

public void setUfid(java.lang.String ufid)

Sets the unique federation identifier of this node.

Parameters:

ufid - The new unique federation identifier.

clone

public com.ptc.core.meta.container.common.AttributeContainer clone(com.ptc.core.meta.common.AttributeTypeIdentifier[] filter,
                                                                   boolean compact)

Specified by:

clone in interface com.ptc.core.meta.container.common.AttributeContainer

cloneWithNewUninitializedIdentifiers

public com.ptc.core.meta.container.common.AttributeContainer cloneWithNewUninitializedIdentifiers(java.util.HashMap map)

Specified by:

cloneWithNewUninitializedIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

extractCopy

public com.ptc.core.meta.container.common.AttributeContainer extractCopy(com.ptc.core.meta.common.TypeInstanceIdentifier the_type_instance_identifier,
                                                                         com.ptc.core.meta.common.AttributeTypeIdentifier[] filter,
                                                                         boolean compact)

Specified by:

extractCopy in interface com.ptc.core.meta.container.common.AttributeContainer

replace

public void replace(com.ptc.core.meta.common.TypeInstanceIdentifier old_id,
                    com.ptc.core.meta.common.TypeInstanceIdentifier new_id)

Specified by:

replace in interface com.ptc.core.meta.container.common.AttributeContainer

addReplacement

public void addReplacement(com.ptc.core.meta.common.ElementIdentifier old_id,
                           com.ptc.core.meta.common.ElementIdentifier new_id)

Specified by:

addReplacement in interface com.ptc.core.meta.container.common.AttributeContainer

getReplacements

public java.util.HashMap getReplacements()

Specified by:

getReplacements in interface com.ptc.core.meta.container.common.AttributeContainer

clearReplacements

public void clearReplacements()

Specified by:

clearReplacements in interface com.ptc.core.meta.container.common.AttributeContainer

getInternal

public java.lang.Object getInternal(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier)

Specified by:

getInternal in interface com.ptc.core.meta.container.common.AttributeContainer

getIdentifier

public com.ptc.core.meta.common.ElementIdentifier getIdentifier()

Specified by:

getIdentifier in interface com.ptc.core.meta.container.common.AttributeContainer

put

public com.ptc.core.meta.common.AttributeIdentifier put(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier,
                                                        java.lang.Object the_content,
                                                        com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container)
                                                 throws com.ptc.core.meta.container.common.IllegalContentException,
                                                        com.ptc.core.meta.container.common.ConstraintException

Specified by:

put in interface com.ptc.core.meta.container.common.AttributeContainer

Throws:

com.ptc.core.meta.container.common.IllegalContentException

com.ptc.core.meta.container.common.ConstraintException

remove

public void remove(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier,
                   com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container)
            throws com.ptc.core.meta.container.common.ConstraintException

Specified by:

remove in interface com.ptc.core.meta.container.common.AttributeContainer

Throws:

com.ptc.core.meta.container.common.ConstraintException

remove

public void remove(com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier,
                   com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container)
            throws com.ptc.core.meta.container.common.ConstraintException

Specified by:

remove in interface com.ptc.core.meta.container.common.AttributeContainer

Throws:

com.ptc.core.meta.container.common.ConstraintException

getAttributeTypeSummary

public com.ptc.core.meta.container.common.AttributeTypeSummary getAttributeTypeSummary(com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier,
                                                                                       com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container,
                                                                                       com.ptc.core.meta.container.common.DescriptorContainer the_descriptor_container)

Specified by:

getAttributeTypeSummary in interface com.ptc.core.meta.container.common.AttributeContainer

getAttributeTypeSummary

public com.ptc.core.meta.container.common.AttributeTypeSummary getAttributeTypeSummary(com.ptc.core.meta.common.AssociationIdentifier the_association_identifier,
                                                                                       com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier,
                                                                                       boolean is_absolute)

Specified by:

getAttributeTypeSummary in interface com.ptc.core.meta.container.common.AttributeContainer

getAttributeTypeSummary

public com.ptc.core.meta.container.common.AttributeTypeSummary getAttributeTypeSummary(com.ptc.core.meta.common.AssociationIdentifier the_association_identifier,
                                                                                       com.ptc.core.meta.common.AttributeTypeIdentifier the_attribute_type_identifier,
                                                                                       boolean is_absolute,
                                                                                       com.ptc.core.meta.container.common.ConstraintContainer the_constraint_container,
                                                                                       com.ptc.core.meta.container.common.DescriptorContainer the_descriptor_container)

Specified by:

getAttributeTypeSummary in interface com.ptc.core.meta.container.common.AttributeContainer

acceptChanges

public void acceptChanges()

Specified by:

acceptChanges in interface com.ptc.core.meta.container.common.AttributeContainer

setState

public void setState(com.ptc.core.meta.common.AttributeIdentifier the_attribute_identifier,
                     com.ptc.core.meta.container.common.State the_state)

Specified by:

setState in interface com.ptc.core.meta.container.common.AttributeContainer

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier the_type_instance_identifier)

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

getAttributeIdentifiers

public com.ptc.core.meta.common.AttributeIdentifier[] getAttributeIdentifiers(com.ptc.core.meta.common.TypeInstanceIdentifier the_type_instance_identifier,
                                                                              com.ptc.core.meta.container.common.State the_state)

Specified by:

getAttributeIdentifiers in interface com.ptc.core.meta.container.common.AttributeContainer

purge

public void purge(com.ptc.core.meta.common.TypeInstanceIdentifier[] the_type_instance_identifiers)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

containsTii

public boolean containsTii(com.ptc.core.meta.common.TypeInstanceIdentifier tii)

Specified by:

containsTii in interface com.ptc.core.meta.container.common.AttributeContainer

purge

public void purge(com.ptc.core.meta.common.AttributeIdentifier[] ais_to_purge)

Specified by:

purge in interface com.ptc.core.meta.container.common.AttributeContainer

replace

public void replace(java.util.HashMap id_map)

Specified by:

replace in interface com.ptc.core.meta.container.common.AttributeContainer