Top Description Fields Methods
javax.xml.registry.infomodel

public Interface ClassificationScheme

extends RegistryEntry
Imports
javax.xml.registry.*, java.util.*
A ClassificationScheme instance represents a taxonomy that may be used to classify or categorize RegistryObject instances. A very common example of a classification scheme in science is the Classification of living things where living things are categorized in under a tree like structure. Another example is the Dewey Decimal system used in libraries to categorize books and other publications. A common example in eBusiness is that of North American Industry Classification System (NAICS), which is a classification scheme used to classify businesses and services by the industry to which they belong.

Figure 1 shows how a ClassificationScheme is used by a Classification to classify a RegistryObject.

Using a ClassificationScheme to Classify an Object
Figure 1. Using a ClassificationScheme to Classify an Object

Field Summary

Modifier and TypeField and Description
public static final int
VALUE_TYPE_EMBEDDED_PATH

Each taxonomy value in ClassificationScheme embeds the full path from scheme to that Concept.

public static final int
VALUE_TYPE_NON_UNIQUE

Taxonomy values in ClassificationScheme may be repeated within the same scheme.

public static final int
VALUE_TYPE_UNIQUE

Each taxonomy value in ClassificationScheme is unique.

Inherited from javax.xml.registry.infomodel.RegistryEntry:
STABILITY_DYNAMICSTABILITY_DYNAMIC_COMPATIBLESTABILITY_STATICSTATUS_APPROVEDSTATUS_DEPRECATEDSTATUS_SUBMITTEDSTATUS_WITHDRAWN

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 Collection<E>

Returns:

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

Gets all descendant Concepts.

public int

Returns:

an integer constant that describes the type of values supported by this ClassificationScheme
getValueType()

Gets the value type for this object.

public boolean

Returns:

trueif this is an external ClassificationScheme; false otherwise
isExternal()

Determines whether this ClassificationScheme is an external ClassificationScheme or an internal ClassificationScheme.

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
setValueType(int
an integer constant that describes the type of values supported by this ClassificationScheme
valueType)

Sets the value type for this object.

Inherited from javax.xml.registry.infomodel.RegistryEntry:
getExpirationgetStabilitygetStatussetExpirationsetStability

Field Detail

VALUE_TYPE_EMBEDDED_PATHback to summary
public static final int VALUE_TYPE_EMBEDDED_PATH

Each taxonomy value in ClassificationScheme embeds the full path from scheme to that Concept. This also implies that each taxonomy value is unique.

VALUE_TYPE_NON_UNIQUEback to summary
public static final int VALUE_TYPE_NON_UNIQUE

Taxonomy values in ClassificationScheme may be repeated within the same scheme. However, two Concepts that have the same parent cannot have the same value.

VALUE_TYPE_UNIQUEback to summary
public static final int VALUE_TYPE_UNIQUE

Each taxonomy value in ClassificationScheme is unique.

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 Jakarta XML Registries 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 Jakarta XML Registries 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 Jakarta XML Registries 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 Jakarta XML Registries provider encounters an internal error
See Also
javax.xml.registry.infomodel.Concept
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 Jakarta XML Registries provider encounters an internal error
See Also
javax.xml.registry.infomodel.Concept
getValueTypeback to summary
public int getValueType() throws JAXRException

Gets the value type for this object. The value type describes how taxonomy values are defined within the scheme.

Capability Level: 1
Returns:int

an integer constant that describes the type of values supported by this ClassificationScheme

Exceptions
JAXRException:
If the Jakarta XML Registries provider encounters an internal error
See Also
ClassificationScheme#VALUE_TYPE_UNIQUE, ClassificationScheme#VALUE_TYPE_EMBEDDED_PATH, ClassificationScheme#VALUE_TYPE_NON_UNIQUE
isExternalback to summary
public boolean isExternal() throws JAXRException

Determines whether this ClassificationScheme is an external ClassificationScheme or an internal ClassificationScheme.

Capability Level: 0
Returns:boolean

trueif this is an external ClassificationScheme; false otherwise

Exceptions
JAXRException:
If the Jakarta XML Registries 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 Jakarta XML Registries 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 Jakarta XML Registries provider encounters an internal error
setValueTypeback to summary
public void setValueType(int valueType) throws JAXRException

Sets the value type for this object.

Capability Level: 1
Parameters
valueType:int

an integer constant that describes the type of values supported by this ClassificationScheme

Exceptions
JAXRException:
If the Jakarta XML Registries provider encounters an internal error
See Also
ClassificationScheme#VALUE_TYPE_UNIQUE, ClassificationScheme#VALUE_TYPE_EMBEDDED_PATH, ClassificationScheme#VALUE_TYPE_NON_UNIQUE