edu.uci.isr.xarch.types
Interface IComponent

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IOptionalComponent, IOptionalComponentPosition

All Known Implementing Classes:

ComponentImpl, OptionalComponentImpl, OptionalComponentPositionImpl

public interface IComponent

extends IXArchElement

Interface for accessing objects of the Component 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	addInterface(IInterface newInterface) Add a interface to this Component.
void	addInterfaces(Collection interfaces) Add a collection of interfaces to this Component.
void	clearDescription() Clear the description from this Component.
void	clearId() Remove the id attribute from this Component.
void	clearInterfaces() Remove all interfaces from this Component.
void	clearType() Clear the type from this Component.
Collection	getAllInterfaces() Get all the interfaces from this Component.
IDescription	getDescription() Get the description from this Component.
String	getId() Get the id attribute from this Component.
IInterface	getInterface(String id) Gets the interface from this Component with the given id.
Collection	getInterfaces(Collection ids) Gets the interfaces from this Component with the given ids.
IXMLLink	getType() Get the type from this Component.
boolean	hasAllInterfaces(Collection interfacesToCheck) Determine if this Component contains each element in the given set of interfaces.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this Component has the given description
boolean	hasId(String id) Determine if the id attribute on this Component has the given value.
boolean	hasInterface(IInterface interfaceToCheck) Determine if this Component contains a given interface.
Collection	hasInterfaces(Collection interfacesToCheck) Determine if this Component contains the given set of interfaces.
boolean	hasType(IXMLLink typeToCheck) Determine if this Component has the given type
boolean	isEqual(IComponent ComponentToCheck) Determine if another Component has the same id as this one.
boolean	isEquivalent(IComponent ComponentToCheck) Determine if another Component is equivalent to this one, ignoring ID's.
void	removeInterface(IInterface interfaceToRemove) Remove the given interface from this Component.
void	removeInterfaces(Collection interfaces) Remove all the given interfaces from this Component.
void	setDescription(IDescription value) Set the description for this Component.
void	setId(String id) Set the id attribute on this Component.
void	setType(IXMLLink value) Set the type for this Component.

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 Component.

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 Component.

getId

public String getId()

Get the id attribute from this Component. 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 Component

hasId

public boolean hasId(String id)

Determine if the id attribute on this Component 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 Component.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this Component.

getDescription

public IDescription getDescription()

Get the description from this Component.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this Component has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addInterface

public void addInterface(IInterface newInterface)

Add a interface to this Component.

Parameters:

newInterface - interface to add.

addInterfaces

public void addInterfaces(Collection interfaces)

Add a collection of interfaces to this Component.

Parameters:

interfaces - interfaces to add.

clearInterfaces

public void clearInterfaces()

Remove all interfaces from this Component.

removeInterface

public void removeInterface(IInterface interfaceToRemove)

Remove the given interface from this Component. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceToRemove - interface to remove.

removeInterfaces

public void removeInterfaces(Collection interfaces)

Remove all the given interfaces from this Component. Matching is done by the isEquivalent(...) function.

Parameters:

interfaces - interface to remove.

getAllInterfaces

public Collection getAllInterfaces()

Get all the interfaces from this Component.

Returns:

all interfaces in this Component.

hasInterface

public boolean hasInterface(IInterface interfaceToCheck)

Determine if this Component contains a given interface.

Returns:

true if this Component contains the given interfaceToCheck, false otherwise.

hasInterfaces

public Collection hasInterfaces(Collection interfacesToCheck)

Determine if this Component contains the given set of interfaces.

Parameters:

interfacesToCheck - interfaces to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in interfaces 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.

hasAllInterfaces

public boolean hasAllInterfaces(Collection interfacesToCheck)

Determine if this Component contains each element in the given set of interfaces.

Parameters:

interfacesToCheck - interfaces to check for.

Returns:

true if every element in interfaces is found in this Component, false otherwise.

getInterface

public IInterface getInterface(String id)

Gets the interface from this Component with the given id.

Parameters:

id - ID to look for.

Returns:

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

getInterfaces

public Collection getInterfaces(Collection ids)

Gets the interfaces from this Component with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

setType

public void setType(IXMLLink value)

Set the type for this Component.

Parameters:

value - new type

clearType

public void clearType()

Clear the type from this Component.

getType

public IXMLLink getType()

Get the type from this Component.

Returns:

type

hasType

public boolean hasType(IXMLLink typeToCheck)

Determine if this Component has the given type

Parameters:

typeToCheck - type to compare

Returns:

true if the types are equivalent, false otherwise

isEqual

public boolean isEqual(IComponent ComponentToCheck)

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

Parameters:

ComponentToCheck - Component to compare with this one.

isEquivalent

public boolean isEquivalent(IComponent ComponentToCheck)

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

Parameters:

ComponentToCheck - Component to compare to this one.

Returns:

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