gov.nih.nci.dtsrpc.client
Class Concept

java.lang.Object
  gov.nih.nci.dtsrpc.client.TreeNode
      gov.nih.nci.dtsrpc.client.Concept

All Implemented Interfaces:

java.io.Serializable

public class Concept

extends TreeNode

implements java.io.Serializable

A Concept is the main terminology element.

Since:

DTSRPC 1.3.3

Version:

1.3.3

Author:

Northrop Grumman Mission Systems

See Also:

Serialized Form

Constructor Summary

Concept()
Constructs a Concept object and initializes it.

Concept(java.lang.String name, int id, java.lang.String code, int namespaceId)
Constructor

Method Summary

void	addAssociation(ConceptAssociation association) Adds an Inverse ConceptAssocation
void	addAssociation(java.lang.String name, java.lang.String value) Adds a ConceptAssocation
void	addInverseAssociation(ConceptAssociation association) Adds an Inverse ConceptAssocation
void	addInverseAssociation(java.lang.String name, java.lang.String value) Adds an Inverse ConceptAssocation
void	addInverseRole(Role role) Adds an inverse Role.
void	addInverseRole(java.lang.String name, java.lang.String value) Adds the specific inverse role to the Concept.
void	addProperty(Property property) Adds a Property
void	addProperty(java.lang.String name, java.lang.String value) Adds the specific property to the Concept.
void	addRole(Role role) Adds a Role
void	addRole(java.lang.String name, java.lang.String value) Adds a Role
java.util.Vector	getAssociationCollection() Gets assocations of the Concept.
java.util.Vector	getAssociations() Gets assocations of the Concept.
java.lang.String	getCode() Gets the code of the Concept.
ConceptAssociation[]	getFetchedConceptAssociations() Gets fetched associations
java.lang.String[]	getFetchedConceptAssociationValues(java.lang.String associationName) Gets fetched concept association values
ConceptAssociation[]	getFetchedInverseConceptAssociations() Gets fetched associations
java.lang.String[]	getFetchedInverseConceptAssociationValues(java.lang.String associationName) Gets fetched concept association values
Role[]	getFetchedinverseRoles() Gets fetched inverse roles
java.lang.String[]	getFetchedinverseRoleValues(java.lang.String roleName) Gets fetched inverse role values
Property[]	getFetchedProperties() Gets fetched properties.
java.lang.String[]	getFetchedPropertyValues(java.lang.String propertyName) Gets fetched property values
Role[]	getFetchedRoles() Gets fetched roles
java.lang.String[]	getFetchedRoleValues(java.lang.String roleName) Gets fetched concept associations
java.lang.Boolean	getHasChildren() Gets the value of hasChildren.
java.lang.Boolean	getHasParents() Gets the value of hasParents.
int	getId() Gets the id of the Concept.
java.util.Vector	getInverseAssociationCollection() Gets assocations of the Concept.
java.util.Vector	getInverseAssociations() Gets assocations of the Concept.
java.util.Vector	getInverseRoleCollection() Gets inverse roles of the Concept.
java.util.Vector	getInverseRoles() Gets inverse roles of the Concept.
java.lang.Boolean	getIsRetired() Gets the value of isRetired.
java.lang.String	getName() Gets the name of the Concept.
int	getNamespaceId() Gets the namespaceId of the Concept.
java.util.Vector	getProperties() Gets properties of the Concept.
java.util.Vector	getPropertyCollection() Gets properties of the Concept.
java.util.Vector	getRoleCollection() Gets roles of the Concept.
java.util.Vector	getRoles() Gets roles of the Concept.
TreeNode	getTreeNode() Gets tree node.
void	setAssociationCollection(java.util.Vector associations) Assigns value to associations.
void	setCode(java.lang.String code) Assigns code value
void	setCode(TreeNode treenode) Assigns tree node
void	setHasChildren(java.lang.Boolean hasChildren) Sets a value to hasChildren.
void	setHasParents(java.lang.Boolean hasParents) Sets a value to hasParents.
void	setId(int id) Assigns id value
void	setInverseAssociationCollection(java.util.Vector associations) Assigns value to inverseAssociations.
void	setInverseRoleCollection(java.util.Vector inverseroles) Assigns value to inverseroles.
void	setIsRetired(java.lang.Boolean isRetired) Sets a value to isRetired.
void	setName(java.lang.String name) Assigns nameid value
void	setNamespaceId(int namespaceId) Assigns namespaceIdid value
void	setPropertyCollection(java.util.Vector properties) Assigns value to properties.
void	setRoleCollection(java.util.Vector roles) Assigns value to roles.
void	setTreeNode(TreeNode treenode) Assigns value to treenode.
org.w3c.dom.Document	toDOM() Gets a XML Document representation of a concept object.
java.lang.String	toString() Gets a String representation of the concept object.
java.lang.String	toXML() Gets the XML representation of the concept object.

Methods inherited from class gov.nih.nci.dtsrpc.client.TreeNode

addLink, getIsA, getLinks, getTraverseDown, setIsA, setLinks, setTraverseDown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Concept

public Concept()

Constructs a Concept object and initializes it.

Since:

DTSRPC 2.0

Concept

public Concept(java.lang.String name,
               int id,
               java.lang.String code,
               int namespaceId)

Constructor

Parameters:

name - concept name

id - concept id

code - concept code

namespaceId - namespace id

Method Detail

setCode

public void setCode(TreeNode treenode)

Assigns tree node

Parameters:

treenode - an instance of TreeNode

setCode

public void setCode(java.lang.String code)

Assigns code value

Parameters:

code - concept code

setId

public void setId(int id)

Assigns id value

Parameters:

id - concept id

setName

public void setName(java.lang.String name)

Assigns nameid value

Overrides:

setName in class TreeNode

Parameters:

name - concept name

setNamespaceId

public void setNamespaceId(int namespaceId)

Assigns namespaceIdid value

Parameters:

namespaceId - namespace id

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)

Adds the specific property to the Concept.

Parameters:

name - the Property name.

value - the Property value.

Since:

DTSRPC 1.3.3

addProperty

public void addProperty(Property property)

Adds a Property

Parameters:

property - a Property instance

addRole

public void addRole(java.lang.String name,
                    java.lang.String value)

Adds a Role

Parameters:

name - the Role name.

value - the Role value.

Since:

DTSRPC 1.3.3

addRole

public void addRole(Role role)

Adds a Role

Parameters:

role - a Role instance

addAssociation

public void addAssociation(java.lang.String name,
                           java.lang.String value)

Adds a ConceptAssocation

Parameters:

name - the ConceptAssocation name.

value - the ConceptAssocation value.

Since:

DTSRPC 2.1

addAssociation

public void addAssociation(ConceptAssociation association)

Adds an Inverse ConceptAssocation

Parameters:

association - a ConceptAssocation instance

Since:

DTSRPC 2.1

addInverseAssociation

public void addInverseAssociation(java.lang.String name,
                                  java.lang.String value)

Adds an Inverse ConceptAssocation

Parameters:

name - the ConceptAssocation name.

value - the ConceptAssocation value.

Since:

DTSRPC 2.1

addInverseAssociation

public void addInverseAssociation(ConceptAssociation association)

Adds an Inverse ConceptAssocation

Parameters:

association - a ConceptAssocation instance

Since:

DTSRPC 2.1

addInverseRole

public void addInverseRole(java.lang.String name,
                           java.lang.String value)

Adds the specific inverse role to the Concept.

Parameters:

name - the Role name.

value - the Role value.

Since:

DTSRPC 1.3.3

addInverseRole

public void addInverseRole(Role role)

Adds an inverse Role.

Parameters:

role - an inverse Role

setRoleCollection

public void setRoleCollection(java.util.Vector roles)

Assigns value to roles.

Parameters:

roles - a vector of Role objects

setPropertyCollection

public void setPropertyCollection(java.util.Vector properties)

Assigns value to properties.

Parameters:

properties - a vector of Property objects

setInverseRoleCollection

public void setInverseRoleCollection(java.util.Vector inverseroles)

Assigns value to inverseroles.

Parameters:

inverseroles - a vector of Role objects

setAssociationCollection

public void setAssociationCollection(java.util.Vector associations)

Assigns value to associations.

Parameters:

associations - a vector of Association objects

setInverseAssociationCollection

public void setInverseAssociationCollection(java.util.Vector associations)

Assigns value to inverseAssociations.

Parameters:

associations - a vector of Association objects

setTreeNode

public void setTreeNode(TreeNode treenode)

Assigns value to treenode.

Parameters:

treenode - a TreeNode object

setHasParents

public void setHasParents(java.lang.Boolean hasParents)

Sets a value to hasParents.

Parameters:

hasParents - a Boolean value indicating whether the concept has any superconcept

setHasChildren

public void setHasChildren(java.lang.Boolean hasChildren)

Sets a value to hasChildren.

Parameters:

hasChildren - a Boolean value indicating whether the concept has any subconcept

setIsRetired

public void setIsRetired(java.lang.Boolean isRetired)

Sets a value to isRetired.

Parameters:

isRetired - a Boolean value indicating whether the concept has been reetired

getName

public java.lang.String getName()

Gets the name of the Concept.

Overrides:

getName in class TreeNode

Returns:

the name of the Concept instance.

Since:

DTSRPC 1.3.3

getId

public int getId()

Gets the id of the Concept.

Returns:

the id of the Concept instance.

Since:

DTSRPC 1.3.3

getCode

public java.lang.String getCode()

Gets the code of the Concept.

Returns:

the code of the Concept instance.

Since:

DTSRPC 1.3.3

getNamespaceId

public int getNamespaceId()

Gets the namespaceId of the Concept.

Returns:

the code of the Concept instance.

Since:

DTSRPC 1.3.3

getProperties

public java.util.Vector getProperties()

Gets properties of the Concept.

Returns:

a vector of Property of the Concept instance.

Since:

DTSRPC 1.3.3

getPropertyCollection

public java.util.Vector getPropertyCollection()

Gets properties of the Concept.

Returns:

a vector of Property of the Concept instance.

Since:

DTSRPC 1.3.3

getRoles

public java.util.Vector getRoles()

Gets roles of the Concept.

Returns:

a vector of Role of the Concept instance.

Since:

DTSRPC 1.3.3

getRoleCollection

public java.util.Vector getRoleCollection()

Gets roles of the Concept.

Returns:

a vector of Role of the Concept instance.

Since:

DTSRPC 1.3.3

getAssociations

public java.util.Vector getAssociations()

Gets assocations of the Concept.

Returns:

a vector of ConceptAssociation of the Concept instance.

Since:

DTSRPC 2.1

getAssociationCollection

public java.util.Vector getAssociationCollection()

Gets assocations of the Concept.

Returns:

a vector of ConceptAssociation of the Concept instance.

Since:

DTSRPC 2.1

getInverseAssociations

public java.util.Vector getInverseAssociations()

Gets assocations of the Concept.

Returns:

a vector of ConceptAssociation of the Concept instance.

Since:

DTSRPC 2.1

getInverseAssociationCollection

public java.util.Vector getInverseAssociationCollection()

Gets assocations of the Concept.

Returns:

a vector of ConceptAssociation of the Concept instance.

Since:

DTSRPC 2.1

getInverseRoles

public java.util.Vector getInverseRoles()

Gets inverse roles of the Concept.

Returns:

a vector of role names of the Concept instance.

Since:

DTSRPC 1.3.3

getInverseRoleCollection

public java.util.Vector getInverseRoleCollection()

Gets inverse roles of the Concept.

Returns:

a vector of role names of the Concept instance.

Since:

DTSRPC 1.3.3

getFetchedProperties

public Property[] getFetchedProperties()

Gets fetched properties.

Returns:

An array of properties

getFetchedPropertyValues

public java.lang.String[] getFetchedPropertyValues(java.lang.String propertyName)

Gets fetched property values

Parameters:

propertyName - a specific property name

Returns:

an array of fetched property values

getFetchedRoles

public Role[] getFetchedRoles()

Gets fetched roles

Returns:

an array of roles

getFetchedRoleValues

public java.lang.String[] getFetchedRoleValues(java.lang.String roleName)

Gets fetched concept associations

Parameters:

roleName - a specific role name

Returns:

An array of role values

getFetchedinverseRoles

public Role[] getFetchedinverseRoles()

Gets fetched inverse roles

Returns:

An array of roles

getFetchedinverseRoleValues

public java.lang.String[] getFetchedinverseRoleValues(java.lang.String roleName)

Gets fetched inverse role values

Parameters:

roleName - a specific role name

Returns:

an array of inverse role values

getFetchedConceptAssociations

public ConceptAssociation[] getFetchedConceptAssociations()

Gets fetched associations

Returns:

an array of associations

getFetchedInverseConceptAssociations

public ConceptAssociation[] getFetchedInverseConceptAssociations()

Gets fetched associations

Returns:

an array of associations

getTreeNode

public TreeNode getTreeNode()

Gets tree node.

Returns:

the TreeNode instance.

Since:

DTSRPC 2.1

getFetchedConceptAssociationValues

public java.lang.String[] getFetchedConceptAssociationValues(java.lang.String associationName)

Gets fetched concept association values

Parameters:

associationName - a specific ConceptAssociation name (i.e., ConceptAssociation type)

Returns:

An array of ConceptAssociation values (i.e., the conceptname of associated concepts)

getFetchedInverseConceptAssociationValues

public java.lang.String[] getFetchedInverseConceptAssociationValues(java.lang.String associationName)

Gets fetched concept association values

Parameters:

associationName - a specific ConceptAssociation name (i.e., ConceptAssociation type)

Returns:

An array of ConceptAssociation values (i.e., the conceptname of associated concepts)

getHasParents

public java.lang.Boolean getHasParents()

Gets the value of hasParents.

getHasChildren

public java.lang.Boolean getHasChildren()

Gets the value of hasChildren.

getIsRetired

public java.lang.Boolean getIsRetired()

Gets the value of isRetired.

toXML

public java.lang.String toXML()

Gets the XML representation of the concept object.

Returns:

the XML representation of the concept object

toString

public java.lang.String toString()

Gets a String representation of the concept object.

Overrides:

toString in class TreeNode

Returns:

a String representation of the concept object

toDOM

public org.w3c.dom.Document toDOM()

Gets a XML Document representation of a concept object.

Returns:

a XML Document representation of a concept object