org.LexGrid.LexBIG.DataModel.Core
Class MetadataProperty

java.lang.Object
  extended by org.LexGrid.LexBIG.DataModel.Core.MetadataProperty
All Implemented Interfaces:
java.io.Serializable

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

Reference to a property name and value stored in the coding scheme metadata.

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

Constructor Summary
MetadataProperty()
           
 
Method Summary
 void addContext(int index, java.lang.Object vContext)
           
 void addContext(java.lang.Object vContext)
           
 java.util.Enumeration<java.lang.Object> enumerateContext()
          Method enumerateContext.
 java.lang.String getCodingSchemeURI()
          Returns the value of field 'codingSchemeURI'.
 java.lang.String getCodingSchemeVersion()
          Returns the value of field 'codingSchemeVersion'.
 java.lang.Object[] getContext()
          Method getContext.Returns the contents of the collection in an Array.
 java.lang.Object getContext(int index)
          Method getContext.
 int getContextCount()
          Method getContextCount.
 java.lang.String getName()
          Returns the value of field 'name'.
 java.lang.String getValue()
          Returns the value of field 'value'.
 java.util.Iterator<java.lang.Object> iterateContext()
          Method iterateContext.
 void removeAllContext()
           
 boolean removeContext(java.lang.Object vContext)
          Method removeContext.
 java.lang.Object removeContextAt(int index)
          Method removeContextAt.
 void setCodingSchemeURI(java.lang.String codingSchemeURI)
          Sets the value of field 'codingSchemeURI'.
 void setCodingSchemeVersion(java.lang.String codingSchemeVersion)
          Sets the value of field 'codingSchemeVersion'.
 void setContext(int index, java.lang.Object vContext)
           
 void setContext(java.lang.Object[] vContextArray)
           
 void setName(java.lang.String name)
          Sets the value of field 'name'.
 void setValue(java.lang.String value)
          Sets the value of field 'value'.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MetadataProperty

public MetadataProperty()
Method Detail

addContext

public void addContext(java.lang.Object vContext)
                throws java.lang.IndexOutOfBoundsException
Parameters:
vContext -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addContext

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

enumerateContext

public java.util.Enumeration<java.lang.Object> enumerateContext()
Method enumerateContext.

Returns:
an Enumeration over all possible elements of this collection

getCodingSchemeURI

public java.lang.String getCodingSchemeURI()
Returns the value of field 'codingSchemeURI'. The field 'codingSchemeURI' has the following description: The registered URN of the associated coding scheme.

Returns:
the value of field 'CodingSchemeURI'.

getCodingSchemeVersion

public java.lang.String getCodingSchemeVersion()
Returns the value of field 'codingSchemeVersion'. The field 'codingSchemeVersion' has the following description: The version of the associated coding scheme. Note that that is the combination of the codingSchemeURN and the version that uniquely represents a coding scheme in the system.

Returns:
the value of field 'CodingSchemeVersion'.

getContext

public java.lang.Object getContext(int index)
                            throws java.lang.IndexOutOfBoundsException
Method getContext.

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

getContext

public java.lang.Object[] getContext()
Method getContext.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

getContextCount

public int getContextCount()
Method getContextCount.

Returns:
the size of this collection

getName

public java.lang.String getName()
Returns the value of field 'name'. The field 'name' has the following description: The metadata property name.

Returns:
the value of field 'Name'.

getValue

public java.lang.String getValue()
Returns the value of field 'value'. The field 'value' has the following description: The metadata property value.

Returns:
the value of field 'Value'.

iterateContext

public java.util.Iterator<java.lang.Object> iterateContext()
Method iterateContext.

Returns:
an Iterator over all possible elements in this collection

removeAllContext

public void removeAllContext()

removeContext

public boolean removeContext(java.lang.Object vContext)
Method removeContext.

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

removeContextAt

public java.lang.Object removeContextAt(int index)
Method removeContextAt.

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

setCodingSchemeURI

public void setCodingSchemeURI(java.lang.String codingSchemeURI)
Sets the value of field 'codingSchemeURI'. The field 'codingSchemeURI' has the following description: The registered URN of the associated coding scheme.

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

setCodingSchemeVersion

public void setCodingSchemeVersion(java.lang.String codingSchemeVersion)
Sets the value of field 'codingSchemeVersion'. The field 'codingSchemeVersion' has the following description: The version of the associated coding scheme. Note that that is the combination of the codingSchemeURN and the version that uniquely represents a coding scheme in the system.

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

setContext

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

setContext

public void setContext(java.lang.Object[] vContextArray)
Parameters:
vContextArray -

setName

public void setName(java.lang.String name)
Sets the value of field 'name'. The field 'name' has the following description: The metadata property name.

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

setValue

public void setValue(java.lang.String value)
Sets the value of field 'value'. The field 'value' has the following description: The metadata property value.

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

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.