edu.uci.isr.xarch.types
Class ComponentTypeImpl

java.lang.Object
  edu.uci.isr.xarch.types.ComponentTypeImpl

All Implemented Interfaces:

DOMBased, IComponentType, IXArchElement

Direct Known Subclasses:

VariantComponentTypeImpl

public class ComponentTypeImpl

extends Object

implements IComponentType, DOMBased

DOM-Based implementation of the IComponentType interface.

Author:

Automatically generated by xArch apigen.

Field Summary

static String	DESCRIPTION_ELT_NAME Tag name for descriptions in this object.
protected Element	elt
static String	ID_ATTR_NAME Tag name for ids in this object.
static String	SIGNATURE_ELT_NAME Tag name for signatures in this object.
static String	SUB_ARCHITECTURE_ELT_NAME Tag name for subArchitectures in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.types.IComponentType

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

ComponentTypeImpl(Element elt)

Method Summary

void	addSignature(ISignature newSignature) Add a signature to this ComponentType.
void	addSignatures(Collection signatures) Add a collection of signatures to this ComponentType.
void	clearDescription() Clear the description from this ComponentType.
void	clearId() Removes the id attribute from this object.
void	clearSignatures() Remove all signatures from this ComponentType.
void	clearSubArchitecture() Clear the subArchitecture from this ComponentType.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
Collection	getAllSignatures() Get all the signatures from this ComponentType.
IDescription	getDescription() Get the description from this ComponentType.
Node	getDOMNode() Gets the DOM node on which this implementation is based.
String	getId() Gets the value of the id attribute on this object.
XArchInstanceMetadata	getInstanceMetadata() Gets metadata describing the instance of this element.
protected static SequenceOrder	getSequenceOrder()
ISignature	getSignature(String id) Gets the signature from this ComponentType with the given id.
Collection	getSignatures(Collection ids) Gets the signatures from this ComponentType with the given ids.
ISubArchitecture	getSubArchitecture() Get the subArchitecture from this ComponentType.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch()
boolean	hasAllSignatures(Collection signaturesToCheck) Determine if this ComponentType contains each element in the given set of signatures.
boolean	hasDescription(IDescription value) Determine if this ComponentType has the given description
int	hashCode()
boolean	hasId(String id) Determines if this object's id attribute has the given value.
boolean	hasSignature(ISignature signatureToCheck) Determine if this ComponentType contains a given signature.
Collection	hasSignatures(Collection signaturesToCheck) Determine if this ComponentType contains the given set of signatures.
boolean	hasSubArchitecture(ISubArchitecture value) Determine if this ComponentType has the given subArchitecture
boolean	isEqual(IComponentType ComponentTypeToCheck) Determine if another ComponentType has the same id as this one.
boolean	isEquivalent(IComponentType c) Determine if another ComponentType is equivalent to this one, ignoring ID's.
void	removeSignature(ISignature signatureToRemove) Remove the given signature from this ComponentType.
void	removeSignatures(Collection signatures) Remove all the given signatures from this ComponentType.
void	setDescription(IDescription value) Set the description for this ComponentType.
void	setDOMNode(Node node) Sets the DOM node on which this implementation is based.
void	setId(String id) Set the id attribute on this object.
void	setSubArchitecture(ISubArchitecture value) Set the subArchitecture for this ComponentType.
void	setXArch(IXArch xArch)

Methods inherited from class java.lang.Object

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

Field Detail

XSD_TYPE_NSURI

public static final String XSD_TYPE_NSURI

See Also:

Constant Field Values

XSD_TYPE_NAME

public static final String XSD_TYPE_NAME

See Also:

Constant Field Values

xArch

protected IXArch xArch

ID_ATTR_NAME

public static final String ID_ATTR_NAME

Tag name for ids in this object.

See Also:

Constant Field Values

DESCRIPTION_ELT_NAME

public static final String DESCRIPTION_ELT_NAME

Tag name for descriptions in this object.

See Also:

Constant Field Values

SIGNATURE_ELT_NAME

public static final String SIGNATURE_ELT_NAME

Tag name for signatures in this object.

See Also:

Constant Field Values

SUB_ARCHITECTURE_ELT_NAME

public static final String SUB_ARCHITECTURE_ELT_NAME

Tag name for subArchitectures in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

ComponentTypeImpl

public ComponentTypeImpl(Element elt)

Method Detail

getDOMNode

public Node getDOMNode()

Description copied from interface: DOMBased

Gets the DOM node on which this implementation is based.

Specified by:

getDOMNode in interface DOMBased

Returns:

DOM node

setDOMNode

public void setDOMNode(Node node)

Description copied from interface: DOMBased

Sets the DOM node on which this implementation is based.

Specified by:

setDOMNode in interface DOMBased

Parameters:

node - DOM node

getSequenceOrder

protected static SequenceOrder getSequenceOrder()

setXArch

public void setXArch(IXArch xArch)

Specified by:

setXArch in interface IXArchElement

getXArch

public IXArch getXArch()

Specified by:

getXArch in interface IXArchElement

cloneElement

public IXArchElement cloneElement(int depth)

Specified by:

cloneElement in interface IXArchElement

equals

public boolean equals(Object o)

hashCode

public int hashCode()

getTypeMetadata

public XArchTypeMetadata getTypeMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the xsi:type of this element.

Specified by:

getTypeMetadata in interface IXArchElement

Returns:

metadata describing the xsi:type of this element.

getInstanceMetadata

public XArchInstanceMetadata getInstanceMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the instance of this element.

Specified by:

getInstanceMetadata in interface IXArchElement

Returns:

metadata describing the instance of this element.

setId

public void setId(String id)

Set the id attribute on this object.

Specified by:

setId in interface IComponentType

Parameters:

id - attribute value.

clearId

public void clearId()

Removes the id attribute from this object.

Specified by:

clearId in interface IComponentType

getId

public String getId()

Gets the value of the id attribute on this object.

Specified by:

getId in interface IComponentType

Returns:

id attribute's value or null if that attribute is not set.

hasId

public boolean hasId(String id)

Determines if this object's id attribute has the given value.

Specified by:

hasId in interface IComponentType

Parameters:

id - value to test.

Returns:

true if the values match, false otherwise. Matching is done by string-matching.

setDescription

public void setDescription(IDescription value)

Description copied from interface: IComponentType

Set the description for this ComponentType.

Specified by:

setDescription in interface IComponentType

Parameters:

value - new description

clearDescription

public void clearDescription()

Description copied from interface: IComponentType

Clear the description from this ComponentType.

Specified by:

clearDescription in interface IComponentType

getDescription

public IDescription getDescription()

Description copied from interface: IComponentType

Get the description from this ComponentType.

Specified by:

getDescription in interface IComponentType

Returns:

description

hasDescription

public boolean hasDescription(IDescription value)

Description copied from interface: IComponentType

Determine if this ComponentType has the given description

Specified by:

hasDescription in interface IComponentType

Parameters:

value - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addSignature

public void addSignature(ISignature newSignature)

Description copied from interface: IComponentType

Add a signature to this ComponentType.

Specified by:

addSignature in interface IComponentType

Parameters:

newSignature - signature to add.

addSignatures

public void addSignatures(Collection signatures)

Description copied from interface: IComponentType

Add a collection of signatures to this ComponentType.

Specified by:

addSignatures in interface IComponentType

Parameters:

signatures - signatures to add.

clearSignatures

public void clearSignatures()

Description copied from interface: IComponentType

Remove all signatures from this ComponentType.

Specified by:

clearSignatures in interface IComponentType

removeSignature

public void removeSignature(ISignature signatureToRemove)

Description copied from interface: IComponentType

Remove the given signature from this ComponentType. Matching is done by the isEquivalent(...) function.

Specified by:

removeSignature in interface IComponentType

Parameters:

signatureToRemove - signature to remove.

removeSignatures

public void removeSignatures(Collection signatures)

Description copied from interface: IComponentType

Remove all the given signatures from this ComponentType. Matching is done by the isEquivalent(...) function.

Specified by:

removeSignatures in interface IComponentType

Parameters:

signatures - signature to remove.

getAllSignatures

public Collection getAllSignatures()

Description copied from interface: IComponentType

Get all the signatures from this ComponentType.

Specified by:

getAllSignatures in interface IComponentType

Returns:

all signatures in this ComponentType.

hasSignature

public boolean hasSignature(ISignature signatureToCheck)

Description copied from interface: IComponentType

Determine if this ComponentType contains a given signature.

Specified by:

hasSignature in interface IComponentType

Returns:

true if this ComponentType contains the given signatureToCheck, false otherwise.

hasSignatures

public Collection hasSignatures(Collection signaturesToCheck)

Description copied from interface: IComponentType

Determine if this ComponentType contains the given set of signatures.

Specified by:

hasSignatures in interface IComponentType

Parameters:

signaturesToCheck - signatures to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in signatures was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllSignatures

public boolean hasAllSignatures(Collection signaturesToCheck)

Description copied from interface: IComponentType

Determine if this ComponentType contains each element in the given set of signatures.

Specified by:

hasAllSignatures in interface IComponentType

Parameters:

signaturesToCheck - signatures to check for.

Returns:

true if every element in signatures is found in this ComponentType, false otherwise.

getSignature

public ISignature getSignature(String id)

Description copied from interface: IComponentType

Gets the signature from this ComponentType with the given id.

Specified by:

getSignature in interface IComponentType

Parameters:

id - ID to look for.

Returns:

signature with the given ID, or null if not found.

getSignatures

public Collection getSignatures(Collection ids)

Description copied from interface: IComponentType

Gets the signatures from this ComponentType with the given ids.

Specified by:

getSignatures in interface IComponentType

Parameters:

ids - ID to look for.

Returns:

signatures with the given IDs. If an element with a given ID was not found, that ID is ignored.

setSubArchitecture

public void setSubArchitecture(ISubArchitecture value)

Description copied from interface: IComponentType

Set the subArchitecture for this ComponentType.

Specified by:

setSubArchitecture in interface IComponentType

Parameters:

value - new subArchitecture

clearSubArchitecture

public void clearSubArchitecture()

Description copied from interface: IComponentType

Clear the subArchitecture from this ComponentType.

Specified by:

clearSubArchitecture in interface IComponentType

getSubArchitecture

public ISubArchitecture getSubArchitecture()

Description copied from interface: IComponentType

Get the subArchitecture from this ComponentType.

Specified by:

getSubArchitecture in interface IComponentType

Returns:

subArchitecture

hasSubArchitecture

public boolean hasSubArchitecture(ISubArchitecture value)

Description copied from interface: IComponentType

Determine if this ComponentType has the given subArchitecture

Specified by:

hasSubArchitecture in interface IComponentType

Parameters:

value - subArchitecture to compare

Returns:

true if the subArchitectures are equivalent, false otherwise

isEqual

public boolean isEqual(IComponentType ComponentTypeToCheck)

Description copied from interface: IComponentType

Determine if another ComponentType has the same id as this one.

Specified by:

isEqual in interface IComponentType

Parameters:

ComponentTypeToCheck - ComponentType to compare with this one.

isEquivalent

public boolean isEquivalent(IComponentType c)

Description copied from interface: IComponentType

Determine if another ComponentType is equivalent to this one, ignoring ID's.

Specified by:

isEquivalent in interface IComponentType

Parameters:

c - ComponentType to compare to this one.

Returns:

true if all the child elements of this ComponentType are equivalent, false otherwise.