org.LexGrid.LexBIG.DataModel.Core
Class CodedNodeReference

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.Core.CodedNodeReference
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ConceptReference

public class CodedNodeReference
extends java.lang.Object
implements java.io.Serializable

A reference to an entity in the coding scheme by code, optionally qualified by namespace and type.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
CodedNodeReference()
           
 
Method Summary
 void addEntityType(int index, java.lang.String vEntityType)
           
 void addEntityType(java.lang.String vEntityType)
           
 java.util.Enumeration<? extends java.lang.String> enumerateEntityType()
          Method enumerateEntityType.
 java.lang.String getCode()
          Returns the value of field 'code'.
 java.lang.String getCodeNamespace()
          Returns the value of field 'codeNamespace'.
 java.lang.String getCodingSchemeName()
          Returns the value of field 'codingSchemeName'.
 java.lang.String[] getEntityType()
          Method getEntityType.Returns the contents of the collection in an Array.
 java.lang.String getEntityType(int index)
          Method getEntityType.
 int getEntityTypeCount()
          Method getEntityTypeCount.
 java.util.Iterator<? extends java.lang.String> iterateEntityType()
          Method iterateEntityType.
 void removeAllEntityType()
           
 boolean removeEntityType(java.lang.String vEntityType)
          Method removeEntityType.
 java.lang.String removeEntityTypeAt(int index)
          Method removeEntityTypeAt.
 void setCode(java.lang.String code)
          Sets the value of field 'code'.
 void setCodeNamespace(java.lang.String codeNamespace)
          Sets the value of field 'codeNamespace'.
 void setCodingSchemeName(java.lang.String codingSchemeName)
          Sets the value of field 'codingSchemeName'.
 void setEntityType(int index, java.lang.String vEntityType)
           
 void setEntityType(java.lang.String[] vEntityTypeArray)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodedNodeReference

public CodedNodeReference()
Method Detail

addEntityType

public void addEntityType(java.lang.String vEntityType)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
vEntityType -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addEntityType

public void addEntityType(int index,
                          java.lang.String vEntityType)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vEntityType -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateEntityType

public java.util.Enumeration<? extends java.lang.String> enumerateEntityType()
Method enumerateEntityType.

Returns:
an Enumeration over all possible elements of this collection

getCode

public java.lang.String getCode()
Returns the value of field 'code'. The field 'code' has the following description: The code uniquely identifying the entity within the coding scheme.

Returns:
the value of field 'Code'.

getCodeNamespace

public java.lang.String getCodeNamespace()
Returns the value of field 'codeNamespace'. The field 'codeNamespace' has the following description: Local identifier of the code namespace. If omitted, namespace is implied from the URI of the coding scheme.

Returns:
the value of field 'CodeNamespace'.

getCodingSchemeName

public java.lang.String getCodingSchemeName()
Returns the value of field 'codingSchemeName'. The field 'codingSchemeName' has the following description: The name of the coding scheme containing the entity

Returns:
the value of field 'CodingSchemeName'.

getEntityType

public java.lang.String getEntityType(int index)
                               throws java.lang.IndexOutOfBoundsException
Method getEntityType.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getEntityType

public java.lang.String[] getEntityType()
Method getEntityType.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getEntityTypeCount

public int getEntityTypeCount()
Method getEntityTypeCount.

Returns:
the size of this collection

iterateEntityType

public java.util.Iterator<? extends java.lang.String> iterateEntityType()
Method iterateEntityType.

Returns:
an Iterator over all possible elements in this collection

removeAllEntityType

public void removeAllEntityType()

removeEntityType

public boolean removeEntityType(java.lang.String vEntityType)
Method removeEntityType.

Parameters:
vEntityType -
Returns:
true if the object was removed from the collection.

removeEntityTypeAt

public java.lang.String removeEntityTypeAt(int index)
Method removeEntityTypeAt.

Parameters:
index -
Returns:
the element removed from the collection

setCode

public void setCode(java.lang.String code)
Sets the value of field 'code'. The field 'code' has the following description: The code uniquely identifying the entity within the coding scheme.

Parameters:
code - the value of field 'code'.

setCodeNamespace

public void setCodeNamespace(java.lang.String codeNamespace)
Sets the value of field 'codeNamespace'. The field 'codeNamespace' has the following description: Local identifier of the code namespace. If omitted, namespace is implied from the URI of the coding scheme.

Parameters:
codeNamespace - the value of field 'codeNamespace'.

setCodingSchemeName

public void setCodingSchemeName(java.lang.String codingSchemeName)
Sets the value of field 'codingSchemeName'. The field 'codingSchemeName' has the following description: The name of the coding scheme containing the entity

Parameters:
codingSchemeName - the value of field 'codingSchemeName'

setEntityType

public void setEntityType(int index,
                          java.lang.String vEntityType)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vEntityType -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setEntityType

public void setEntityType(java.lang.String[] vEntityTypeArray)
Parameters:
vEntityTypeArray -

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.