public interface

Concept

implements ILazy KnowledgebaseObject
vars.knowledgebase.Concept
Known Indirect Subclasses

Summary

Constants
String ORIGINATOR_UNKNOWN
String PROP_NODC_CODE
String PROP_ORIGINATOR
String PROP_PARENT_CONCEPT
String PROP_RANK_LEVEL
String PROP_RANK_NAME
String PROP_REFERENCE
String PROP_STRUCTURE_TYPE
Public Methods
abstract void addChildConcept(Concept child)
Adds a child Concept object to this Concept.
abstract void addConceptName(ConceptName conceptName)
Associates a ConceptName to this Concept.
abstract List<Concept> getChildConcepts()
Returns an array of the Concept objects identified as immediately below this Concept in the KnowledgeBase hierarchy.
abstract ConceptMetadata getConceptMetadata()

This method should not be called directly by an application developer.

abstract ConceptName getConceptName(String name)
Gets the ConceptName object of the specified String name.
abstract Set<ConceptName> getConceptNames()
This method returns a defensive copy.
abstract String getNodcCode()
Gets the nodcCode attribute of the Concept object
abstract String getOriginator()
Gets the String name of the originator of the placement of this Concept in the Knowledge Base heirarchy.
abstract Concept getParentConcept()
Gets the parentConcept Concept of this Concept.
abstract ConceptName getPrimaryConceptName()
Gets the unique ConceptName object which represents the primary name of this Concept.
abstract String getRankLevel()
Gets the rankLevel attribute of the Concept object
abstract String getRankName()
Gets the rankName attribute of the Concept object
abstract String getReference()
Gets the reference attribute of the Concept object
abstract Concept getRootConcept()
Returns the root concept of this branch of concepts
abstract String getStructureType()
Gets the structure type of this Concept.
abstract String getTaxonomyType()
abstract boolean hasChildConcepts()
Indicates whether this Concept has any child concepts in the hierarchy.
abstract boolean hasDescendent(String child)
Searches down through the concept heirarchy to see if this concept or one of its descendents contains a ConceptName that matches the argument
abstract boolean hasDetails()
Returns boolean whether this Concept has details associated with it (it is more than just a ConceptName).
abstract boolean hasParent()
Indicates whether this Concept has a parentConcept Concept in the hierarchy of the KnowledgeBase.
abstract void removeChildConcept(Concept childConcept)
Removes a child Concept from this Concept .
abstract void removeConceptName(ConceptName conceptName)
Removes the specified ConceptName from this Concept .
abstract void setNodcCode(String nodcCode)
Sets the nodcCode attribute of the Concept object
abstract void setOriginator(String originator)
Sets the originator attribute of the Concept object
abstract void setRankLevel(String rankLevel)
Sets the rankLevel attribute of the Concept object
abstract void setRankName(String rankName)
Sets the rankName attribute of the Concept object
abstract void setReference(String reference)
Sets the reference attribute of the Concept object
abstract void setStructureType(String structureType)
Sets the structureType attribute of the Concept object.
abstract void setTaxonomyType(String taxonomyType)
[Expand]
Inherited Methods
From interface vars.ILazy
From interface vars.VARSObject

Constants

public static final String ORIGINATOR_UNKNOWN

Constant Value: "unknown"

public static final String PROP_NODC_CODE

Constant Value: "nodcCode"

public static final String PROP_ORIGINATOR

Constant Value: "originator"

public static final String PROP_PARENT_CONCEPT

Constant Value: "parentConcept"

public static final String PROP_RANK_LEVEL

Constant Value: "rankLevel"

public static final String PROP_RANK_NAME

Constant Value: "rankName"

public static final String PROP_REFERENCE

Constant Value: "reference"

public static final String PROP_STRUCTURE_TYPE

Constant Value: "structureType"

Public Methods

public abstract void addChildConcept (Concept child)

Adds a child Concept object to this Concept.

Parameters
child A Concept object identified as a child of this Concept in the KnowledgeBase hierarchy.

public abstract void addConceptName (ConceptName conceptName)

Associates a ConceptName to this Concept. If a ConceptName is primary and it's added to a concept that already has a primary conceptName, then the existing primary name is changed to type NAMETYPE_SYNONYM while the new one becomes the primary name.

Parameters
conceptName A ConceptName to associate with this Concept.
Returns
  • Description of the Return Value
See Also

public abstract List<Concept> getChildConcepts ()

Returns an array of the Concept objects identified as immediately below this Concept in the KnowledgeBase hierarchy.

Returns
  • An array of the children Concept objects of this Concept.

public abstract ConceptMetadata getConceptMetadata ()

This method should not be called directly by an application developer.

In order to speed up database transactions most of the anxillary classes are now associated with a delegate rather than directly to a Concept. This delegate is lazy loaded using IDAO objects because castor does not support lazy loading. This should speed up transactions greatly.

Returns
  • The conceptDelegate which matintains associations to anxillary information classes.

public abstract ConceptName getConceptName (String name)

Gets the ConceptName object of the specified String name. Returns null if this Concept has no such associated ConceptName.

Parameters
name Description of the Parameter
Returns
  • The ConceptName object of the specified String name; null if this Concept has no such ConceptName.
See Also

public abstract Set<ConceptName> getConceptNames ()

This method returns a defensive copy. Adds or removes will have no affect on the database. However, modifications to the objects can be persisted.

Returns
  • The collection of ConceptNames associated with this Concept. This a syncrhonized collection so you will need to synchronize on it before iterating.

public abstract String getNodcCode ()

Gets the nodcCode attribute of the Concept object

Returns
  • The nodcCode value

public abstract String getOriginator ()

Gets the String name of the originator of the placement of this Concept in the Knowledge Base heirarchy. (i.e The name of the person who entered this concept into the Knowledge Base)

Returns
  • The String name of the originator of the placement of this Concept in the Knowledge Base heirarchy.

public abstract Concept getParentConcept ()

Gets the parentConcept Concept of this Concept. Concept objects at the root of the KnowledgeBase hierarchy do not have a parentConcept Concept.

Returns
  • The parentConcept Concept of this Concept. null if no parent is found.

public abstract ConceptName getPrimaryConceptName ()

Gets the unique ConceptName object which represents the primary name of this Concept.

Returns
  • The unique ConceptName object which represents the primary name of this Concept.
See Also

public abstract String getRankLevel ()

Gets the rankLevel attribute of the Concept object

Returns
  • The rankLevel value

public abstract String getRankName ()

Gets the rankName attribute of the Concept object

Returns
  • The rankName value

public abstract String getReference ()

Gets the reference attribute of the Concept object

Returns
  • The reference value

public abstract Concept getRootConcept ()

Returns the root concept of this branch of concepts

Returns
  • The root concept

public abstract String getStructureType ()

Gets the structure type of this Concept.

Returns
  • The structure type of this Concept.

public abstract String getTaxonomyType ()

public abstract boolean hasChildConcepts ()

Indicates whether this Concept has any child concepts in the hierarchy.

Returns
  • A boolean whether this Concept has any children.

public abstract boolean hasDescendent (String child)

Searches down through the concept heirarchy to see if this concept or one of its descendents contains a ConceptName that matches the argument

Parameters
child The String name to search for. This is compared against all ConceptNames that this concept and its descendents contain.
Returns
  • true if this concept or one of its descendents has a ConceptName that matches the argument.

public abstract boolean hasDetails ()

Returns boolean whether this Concept has details associated with it (it is more than just a ConceptName).

Returns
  • A boolean whether this Concept has associated details.

public abstract boolean hasParent ()

Indicates whether this Concept has a parentConcept Concept in the hierarchy of the KnowledgeBase.

Returns
  • true if this Concept has a parentConcept Concept in the hierarchy of the KnowledgeBase;false otherwise.

public abstract void removeChildConcept (Concept childConcept)

Removes a child Concept from this Concept .

Parameters
childConcept A Concept to remove from this Concept .
Returns
  • true if the child Concept is removed.
See Also

public abstract void removeConceptName (ConceptName conceptName)

Removes the specified ConceptName from this Concept .

Parameters
conceptName The ConceptName to remove from this Concept .
Returns
  • true if successfully removed.
See Also

public abstract void setNodcCode (String nodcCode)

Sets the nodcCode attribute of the Concept object

Parameters
nodcCode The new nodcCode value

public abstract void setOriginator (String originator)

Sets the originator attribute of the Concept object

Parameters
originator The new originator value

public abstract void setRankLevel (String rankLevel)

Sets the rankLevel attribute of the Concept object

Parameters
rankLevel The new rankLevel value

public abstract void setRankName (String rankName)

Sets the rankName attribute of the Concept object

Parameters
rankName The new rankName value

public abstract void setReference (String reference)

Sets the reference attribute of the Concept object

Parameters
reference The new reference value

public abstract void setStructureType (String structureType)

Sets the structureType attribute of the Concept object. Valid values are Concept.TAXONOMY, Concept>LITHOLOGY

Parameters
structureType The new structureType value

public abstract void setTaxonomyType (String taxonomyType)