Top Description Methods
javax.xml.registry.infomodel

public Interface Concept

extends RegistryObject
Imports
java.util.*, javax.xml.registry.*

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.

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

Using Concepts to Represent Taxonomy Elements
Figure 1. Using Concepts to Represent Taxonomy Elements
Author
Farrukh S. Najmi
See Also
RegistryObject, Classification, ClassificationScheme

Method Summary

Modifier and TypeMethod and Description
public void
addChildConcept(Concept
the concept being added as a child of this object
concept
)

Adds a child Concept.

public void
addChildConcepts(Collection<E>
the Collection of Concepts being added as a children of this object
concepts
)

Adds a Collection of Concept children.

public int

Returns:

the number of children Concepts
getChildConceptCount
()

Gets number of children.

public Collection<E>

Returns:

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

Gets all immediate children Concepts.

public ClassificationScheme

Returns:

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

Gets the ClassificationScheme that this Concept is a descendent of.

public Collection<E>

Returns:

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

Gets all descendant Concepts.

public RegistryObject

Returns:

the parent Concept or ClassificationScheme for this object
getParent
()

Gets the parent Concept or ClassificationScheme for this object.

public Concept

Returns:

the Concept that is the parent of this object
getParentConcept
()

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

public String

Returns:

the canonical path String representing this object
getPath
()

Gets the canonical path representation for this Concept.

public String

Returns:

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

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

public void
removeChildConcept(Concept
the concept being removed as a child Concept of this object
concept
)

Removes a child Concept.

public void
removeChildConcepts(Collection<E>
the Collection of Concepts being removed as children Concepts of this object
concepts
)

Removes a Collection of children Concepts.

public void
setValue(String
the value (usually a taxonomy value) associated with this Concept
value
)

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

Inherited from javax.xml.registry.infomodel.RegistryObject:
addAssociationaddAssociationsaddClassificationaddClassificationsaddExternalIdentifieraddExternalIdentifiersaddExternalLinkaddExternalLinksgetAssociatedObjectsgetAssociationsgetAuditTrailgetClassificationsgetDescriptiongetExternalIdentifiersgetExternalLinksgetKeygetLifeCycleManagergetNamegetObjectTypegetRegistryPackagesgetSubmittingOrganizationremoveAssociationremoveAssociationsremoveClassificationremoveClassificationsremoveExternalIdentifierremoveExternalIdentifiersremoveExternalLinkremoveExternalLinkssetAssociationssetClassificationssetDescriptionsetExternalIdentifierssetExternalLinkssetKeysetNametoXML

Method Detail

addChildConceptback to summary
public void addChildConcept(Concept concept) throws JAXRException

Adds a child Concept.

Capability Level: 0
Parameters
concept:Concept

the concept being added as a child of this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addChildConceptsback to summary
public void addChildConcepts(Collection<E> concepts) throws JAXRException

Adds a Collection of Concept children.

Capability Level: 0
Parameters
concepts:Collection<E>

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getChildConceptCountback to summary
public int getChildConceptCount() throws JAXRException

Gets number of children.

Capability Level: 0
Returns:int

the number of children Concepts

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getChildrenConceptsback to summary
public Collection<E> getChildrenConcepts() throws JAXRException

Gets all immediate children Concepts.

Capability Level: 0
Returns:Collection<E>

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Concept
getClassificationSchemeback to summary
public ClassificationScheme getClassificationScheme() throws JAXRException

Gets the ClassificationScheme that this Concept is a descendent of.

Capability Level: 0
Returns:ClassificationScheme

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getDescendantConceptsback to summary
public Collection<E> getDescendantConcepts() throws JAXRException

Gets all descendant Concepts.

Capability Level: 0
Returns:Collection<E>

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Concept
getParentback to summary
public RegistryObject getParent() throws JAXRException

Gets the parent Concept or ClassificationScheme for this object.

Capability Level: 0
Returns:RegistryObject

the parent Concept or ClassificationScheme for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getParentConceptback to summary
public Concept getParentConcept() throws JAXRException

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

Capability Level: 0
Returns:Concept

the Concept that is the parent of this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getPathback to summary
public String getPath() throws JAXRException

Gets the canonical path representation for this Concept.

Capability Level: 0
Returns:String

the canonical path String representing this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getValueback to summary
public String getValue() throws JAXRException

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

Capability Level: 0
Returns:String

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeChildConceptback to summary
public void removeChildConcept(Concept concept) throws JAXRException

Removes a child Concept.

Capability Level: 0
Parameters
concept:Concept

the concept being removed as a child Concept of this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeChildConceptsback to summary
public void removeChildConcepts(Collection<E> concepts) throws JAXRException

Removes a Collection of children Concepts.

Capability Level: 0
Parameters
concepts:Collection<E>

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setValueback to summary
public void setValue(String value) throws JAXRException

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

Capability Level: 0
Parameters
value:String

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

Exceptions
JAXRException:
If the JAXR provider encounters an internal error