oracle.hsgbu.ets.base

Interface HierarchicalConcept

All Superinterfaces:

AttributableETSComponent, Concept, ETSComponent, ReassignableETSComponent, RetirableETSComponent

public interface HierarchicalConcept
extends Concept

Defines common methods for terminologies that have a tree-like structure for concepts. The operations defined provide methods for navigating the concept tree hierarchy. This interface is only implemented if the terminology has a well-defined parent-child tree structure for concepts.

See Also:

Concept

Field Summary

Fields inherited from interface oracle.hsgbu.ets.base.Concept

DEFAULT_EQUIVALENCE_CONTEXT, EQUIVALENCE_TYPE_EXACT_CONCEPT, EQUIVALENCE_TYPE_MAPPING, EQUIVALENCE_TYPE_SEMANTIC, LOCAL_PREFERRED, MAXLENGTH_EXT_TYPE_CODE, NONE, TERMINOLOGY_PREFERRED, TERMINOLOGY_PREFERRED_AND_LOCAL_PREFERRED, TYPE_DESC, TYPE_PRINT

Method Summary

Modifier and Type	Method and Description
Concept[]	getAllChildren() Gets an array of all the children from this node down.
Concept[]	getAncestors() Gets an array of ancestor concepts.
Concept[]	getChildren() Gets an array of immediate children of the node.
Concept	getParent() Gets the parent Concept of this node.
Concept	getRoot() Gets the root Concept for the given terminology.

Methods inherited from interface oracle.hsgbu.ets.base.Concept

getAllDescriptions, getAllDescriptions, getClassifications, getCodingSchemeVersion, getConceptCode, getConceptListsContainingConcept, getConceptListsContainingConcept, getDescription, getDescription, getDescription, getEquivalentConcepts, getEquivalentConcepts, getEquivalentConcepts, getExtendedTypeCode, getLocallyPreferredDescription, getLocallyPreferredDescription, getLocallySpecifiedDescriptions, getLocallySpecifiedDescriptions, getMappedConcepts, getMappedConcepts, getRelatedConcepts, getRelatedConcepts, getRelatedConcepts, getRelationships, getRelationships, getTerminologyPreferredDescription, getTerminologyPreferredDescription, getTerminologySpecifiedDescriptions, getTerminologySpecifiedDescriptions, isEquivalent, isEquivalent, isRelationType

Methods inherited from interface oracle.hsgbu.ets.base.ReassignableETSComponent

getFinalAssignment, getNextAssignment, getPreviousAssignments, isReassigned

Methods inherited from interface oracle.hsgbu.ets.base.RetirableETSComponent

getRetiredDate, getVersionID, isActive, isInternal, isQuarantined, isRetired

Methods inherited from interface oracle.hsgbu.ets.base.AttributableETSComponent

getAttributeNames, getAttributes, getAttributes

Methods inherited from interface oracle.hsgbu.ets.base.ETSComponent

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Method Detail

getRoot

Concept getRoot()
         throws ETSDataException,
                ETSNotFoundException

Gets the root Concept for the given terminology.

Returns:

Root Concept for the given terminology. If this method is called on the root concept, null is returned.

Throws:

ETSNotFoundException - If the given concept is the root.

ETSDataException - If data transport error occurs.

getParent

Concept getParent()
           throws ETSDataException,
                  ETSNotFoundException

Gets the parent Concept of this node.

Returns:

Parent Concept of this node. This method returns null if it is called on the root concept.

Throws:

ETSNotFoundException - If the given concept is the root.

ETSDataException - If a data transport error occurs.

getAncestors

Concept[] getAncestors()
                throws ETSDataException

Gets an array of ancestor concepts.

Returns:

Array of ancestor Concept objects, or zero-length array if the method is called from the root.

Throws:

ETSDataException - If a data transport error occurs.

getChildren

Concept[] getChildren()
               throws ETSDataException

Gets an array of immediate children of the node.

Returns:

Array of child Concept objects, or zero-length array if the concept has no child.

Throws:

ETSDataException - If a data transport error occurs.

getAllChildren

Concept[] getAllChildren()
                  throws ETSDataException

Gets an array of all the children from this node down.

Returns:

Array of child Concept objects, or zero-length array if this node is a leaf.

Throws:

ETSDataException - If a data transport error occurs.