edu.uci.isr.xarch.types
Interface IComponentType

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IVariantComponentType, IVariantComponentTypeImpl, IVariantComponentTypeImplVers, IVariantComponentTypeImplVersSpec

All Known Implementing Classes:

ComponentTypeImpl, VariantComponentTypeImpl, VariantComponentTypeImplImpl, VariantComponentTypeImplVersImpl, VariantComponentTypeImplVersSpecImpl

public interface IComponentType

extends IXArchElement

Interface for accessing objects of the ComponentType xsi:type in the types namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

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() Remove the id attribute from this ComponentType.
void	clearSignatures() Remove all signatures from this ComponentType.
void	clearSubArchitecture() Clear the subArchitecture from this ComponentType.
Collection	getAllSignatures() Get all the signatures from this ComponentType.
IDescription	getDescription() Get the description from this ComponentType.
String	getId() Get the id attribute from this ComponentType.
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.
boolean	hasAllSignatures(Collection signaturesToCheck) Determine if this ComponentType contains each element in the given set of signatures.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this ComponentType has the given description
boolean	hasId(String id) Determine if the id attribute on this ComponentType 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 subArchitectureToCheck) 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 ComponentTypeToCheck) 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	setId(String id) Set the id attribute on this ComponentType.
void	setSubArchitecture(ISubArchitecture value) Set the subArchitecture for this ComponentType.

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

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setId

public void setId(String id)

Set the id attribute on this ComponentType.

Parameters:

id - id

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearId

public void clearId()

Remove the id attribute from this ComponentType.

getId

public String getId()

Get the id attribute from this ComponentType. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

id on this ComponentType

hasId

public boolean hasId(String id)

Determine if the id attribute on this ComponentType has the given value.

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this ComponentType.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this ComponentType.

getDescription

public IDescription getDescription()

Get the description from this ComponentType.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this ComponentType has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addSignature

public void addSignature(ISignature newSignature)

Add a signature to this ComponentType.

Parameters:

newSignature - signature to add.

addSignatures

public void addSignatures(Collection signatures)

Add a collection of signatures to this ComponentType.

Parameters:

signatures - signatures to add.

clearSignatures

public void clearSignatures()

Remove all signatures from this ComponentType.

removeSignature

public void removeSignature(ISignature signatureToRemove)

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

Parameters:

signatureToRemove - signature to remove.

removeSignatures

public void removeSignatures(Collection signatures)

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

Parameters:

signatures - signature to remove.

getAllSignatures

public Collection getAllSignatures()

Get all the signatures from this ComponentType.

Returns:

all signatures in this ComponentType.

hasSignature

public boolean hasSignature(ISignature signatureToCheck)

Determine if this ComponentType contains a given signature.

Returns:

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

hasSignatures

public Collection hasSignatures(Collection signaturesToCheck)

Determine if this ComponentType contains the given set of signatures.

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)

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

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)

Gets the signature from this ComponentType with the given id.

Parameters:

id - ID to look for.

Returns:

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

getSignatures

public Collection getSignatures(Collection ids)

Gets the signatures from this ComponentType with the given ids.

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)

Set the subArchitecture for this ComponentType.

Parameters:

value - new subArchitecture

clearSubArchitecture

public void clearSubArchitecture()

Clear the subArchitecture from this ComponentType.

getSubArchitecture

public ISubArchitecture getSubArchitecture()

Get the subArchitecture from this ComponentType.

Returns:

subArchitecture

hasSubArchitecture

public boolean hasSubArchitecture(ISubArchitecture subArchitectureToCheck)

Determine if this ComponentType has the given subArchitecture

Parameters:

subArchitectureToCheck - subArchitecture to compare

Returns:

true if the subArchitectures are equivalent, false otherwise

isEqual

public boolean isEqual(IComponentType ComponentTypeToCheck)

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

Parameters:

ComponentTypeToCheck - ComponentType to compare with this one.

isEquivalent

public boolean isEquivalent(IComponentType ComponentTypeToCheck)

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

Parameters:

ComponentTypeToCheck - ComponentType to compare to this one.

Returns:

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