javax.xml.registry.infomodel
Interface Concept

All Superinterfaces:

ExtensibleObject, RegistryObject

public interface Concept

extends RegistryObject

The Concept interface is used to represent taxonomy elements and their structural relationship with each other in order to describe an internal taxonomy. Concept instances are used to define tree structures where the root of the tree is a ClassificationScheme instance and each node in the tree is a Concept instance. Two Concepts may be defined as being equivalent.

The figure below shows how Concept instances are used to represent taxonomy elements and their structural relationship with each other in order to describe an internal taxonomy.

See Also:

RegistryObject, Classification, ClassificationScheme

Method Summary

void	addChildConcept(Concept concept) Add a child Concept
void	addChildConcepts(java.util.Collection concepts) Add a Collection of Concept children
int	getChildConceptCount() Get number of children
java.util.Collection	getChildrenConcepts() Get all immediate children Concepts
ClassificationScheme	getClassificationScheme() Get the ClassificationScheme that this Concept is a descendent of
java.util.Collection	getDescendantConcepts() Get all descendant Concepts
RegistryObject	getParent() Gets the parent Concept or ClassificationScheme for this object.
Concept	getParentConcept() Get the parent Concept or null if parent is a ClassificationScheme.
java.lang.String	getPath() Gets the canonical path representation for this Concept.
java.lang.String	getValue() Gets the value (usually a code in a taxonomy) associated with this Concept.
void	removeChildConcept(Concept concept) Remove a child Concept
void	removeChildConcepts(java.util.Collection concepts) Remove a Collection of children Concepts
void	setValue(java.lang.String value) Sets the value (usually a taxonomy value) associated with this Concept.

Methods inherited from interface javax.xml.registry.infomodel.RegistryObject

addAssociation, addAssociations, addClassification, addClassifications, addExternalIdentifier, addExternalIdentifiers, addExternalLink, addExternalLinks, getAssociatedObjects, getAssociations, getAuditTrail, getClassifications, getDescription, getExternalIdentifiers, getExternalLinks, getKey, getLifeCycleManager, getName, getObjectType, getRegistryPackages, getSubmittingOrganization, removeAssociation, removeAssociations, removeClassification, removeClassifications, removeExternalIdentifier, removeExternalIdentifiers, removeExternalLink, removeExternalLinks, setAssociations, setClassifications, setDescription, setExternalIdentifiers, setExternalLinks, setKey, setName, toXML

Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject

addSlot, addSlots, getSlot, getSlots, removeSlot, removeSlots

Method Detail

getValue

public java.lang.String getValue()
                          throws JAXRException

Gets the value (usually a code in a taxonomy) associated with this Concept.

Capability Level: 0

Returns:

the value (usually a taxonomy value) associated with this Concept

Throws:

JAXRException - If the JAXR provider encounters an internal error

setValue

public void setValue(java.lang.String value)
              throws JAXRException

Sets the value (usually a taxonomy value) associated with this Concept.

Capability Level: 0

Parameters:

value - the value (usually a taxonomy value) associated with this Concept

Throws:

JAXRException - If the JAXR provider encounters an internal error

addChildConcept

public void addChildConcept(Concept concept)
                     throws JAXRException

Add a child Concept

Capability Level: 0

Parameters:

concept - the concept being added as a child of this object

Throws:

JAXRException - If the JAXR provider encounters an internal error

addChildConcepts

public void addChildConcepts(java.util.Collection concepts)
                      throws JAXRException

Add a Collection of Concept children

Capability Level: 0

Parameters:

concepts - the Collection of Concepts being added as a children of this object

Throws:

JAXRException - If the JAXR provider encounters an internal error

removeChildConcept

public void removeChildConcept(Concept concept)
                        throws JAXRException

Remove a child Concept

Capability Level: 0

Parameters:

concept - the concept being removed as a child Concept of this object

Throws:

JAXRException - If the JAXR provider encounters an internal error

removeChildConcepts

public void removeChildConcepts(java.util.Collection concepts)
                         throws JAXRException

Remove a Collection of children Concepts

Capability Level: 0

Parameters:

concepts - the Collection of Concepts being removed as children Concepts of this object

Throws:

JAXRException - If the JAXR provider encounters an internal error

getChildConceptCount

public int getChildConceptCount()
                         throws JAXRException

Get number of children

Capability Level: 0

Returns:

the number of children Concepts

Throws:

JAXRException - If the JAXR provider encounters an internal error

getChildrenConcepts

public java.util.Collection getChildrenConcepts()
                                         throws JAXRException

Get all immediate children Concepts

Capability Level: 0

Returns:

Collection of Concept instances. The Collection may be empty but not null.

Throws:

JAXRException - If the JAXR provider encounters an internal error

See Also:

Concept

getDescendantConcepts

public java.util.Collection getDescendantConcepts()
                                           throws JAXRException

Get all descendant Concepts

Capability Level: 0

Returns:

Collection of Concept instances. The Collection may be empty but not null.

Throws:

JAXRException - If the JAXR provider encounters an internal error

See Also:

Concept

getParentConcept

public Concept getParentConcept()
                         throws JAXRException

Get the parent Concept or null if parent is a ClassificationScheme.

Capability Level: 0

Returns:

the Concept that is the parent of this object

Throws:

JAXRException - If the JAXR provider encounters an internal error

getClassificationScheme

public ClassificationScheme getClassificationScheme()
                                             throws JAXRException

Get the ClassificationScheme that this Concept is a descendent of

Capability Level: 0

Returns:

the ClassificationScheme that is the ancestor of this object. May return null

Throws:

JAXRException - If the JAXR provider encounters an internal error

getPath

public java.lang.String getPath()
                         throws JAXRException

Gets the canonical path representation for this Concept.

Capability Level: 0

Returns:

the canonical path String representing this object

Throws:

JAXRException - If the JAXR provider encounters an internal error

getParent

public RegistryObject getParent()
                         throws JAXRException

Gets the parent Concept or ClassificationScheme for this object.

Capability Level: 0

Returns:

the parent Concept or ClassificationScheme for this object

Throws:

JAXRException - If the JAXR provider encounters an internal error