org.LexGrid.LexOnt
Class CodingSchemeManifest

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.LexOnt.CodingSchemeManifest
All Implemented Interfaces:
java.io.Serializable

public class CodingSchemeManifest
extends LexGridBase
implements java.io.Serializable

Class CodingSchemeManifest.

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

Constructor Summary
CodingSchemeManifest()
           
 
Method Summary
 void addLocalName(CsmfLocalName vLocalName)
           
 void addLocalName(int index, CsmfLocalName vLocalName)
           
 void addSource(CsmfSource vSource)
           
 void addSource(int index, CsmfSource vSource)
           
 java.util.Enumeration<? extends CsmfLocalName> enumerateLocalName()
          Method enumerateLocalName.
 java.util.Enumeration<? extends CsmfSource> enumerateSource()
          Method enumerateSource.
 CsmfAssociationDefinition getAssociationDefinitions()
          Returns the value of field 'associationDefinitions'.
 CsmfCodingSchemeName getCodingScheme()
          Returns the value of field 'codingScheme'.
 CsmfCodingSchemeURI getCodingSchemeURI()
          Returns the value of field 'codingSchemeURI'.
 CsmfText getCopyright()
          Returns the value of field 'copyright'.
 CsmfDefaultLanguage getDefaultLanguage()
          Returns the value of field 'defaultLanguage'.
 CsmfEntityDescription getEntityDescription()
          Returns the value of field 'entityDescription'.
 CsmfFormalName getFormalName()
          Returns the value of field 'formalName'.
 java.lang.String getId()
          Returns the value of field 'id'.
 CsmfLocalName[] getLocalName()
          Method getLocalName.Returns the contents of the collection in an Array.
 CsmfLocalName getLocalName(int index)
          Method getLocalName.
 java.util.List<CsmfLocalName> getLocalNameAsReference()
          Method getLocalNameAsReference.Returns a reference to '_localNameList'.
 int getLocalNameCount()
          Method getLocalNameCount.
 CsmfMappings getMappings()
          Returns the value of field 'mappings'.
 CsmfVersion getRepresentsVersion()
          Returns the value of field 'representsVersion'.
 CsmfSource[] getSource()
          Method getSource.Returns the contents of the collection in an Array.
 CsmfSource getSource(int index)
          Method getSource.
 java.util.List<CsmfSource> getSourceAsReference()
          Method getSourceAsReference.Returns a reference to '_sourceList'.
 int getSourceCount()
          Method getSourceCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends CsmfLocalName> iterateLocalName()
          Method iterateLocalName.
 java.util.Iterator<? extends CsmfSource> iterateSource()
          Method iterateSource.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllLocalName()
           
 void removeAllSource()
           
 boolean removeLocalName(CsmfLocalName vLocalName)
          Method removeLocalName.
 CsmfLocalName removeLocalNameAt(int index)
          Method removeLocalNameAt.
 boolean removeSource(CsmfSource vSource)
          Method removeSource.
 CsmfSource removeSourceAt(int index)
          Method removeSourceAt.
 void setAssociationDefinitions(CsmfAssociationDefinition associationDefinitions)
          Sets the value of field 'associationDefinitions'.
 void setCodingScheme(CsmfCodingSchemeName codingScheme)
          Sets the value of field 'codingScheme'.
 void setCodingSchemeURI(CsmfCodingSchemeURI codingSchemeURI)
          Sets the value of field 'codingSchemeURI'.
 void setCopyright(CsmfText copyright)
          Sets the value of field 'copyright'.
 void setDefaultLanguage(CsmfDefaultLanguage defaultLanguage)
          Sets the value of field 'defaultLanguage'.
 void setEntityDescription(CsmfEntityDescription entityDescription)
          Sets the value of field 'entityDescription'.
 void setFormalName(CsmfFormalName formalName)
          Sets the value of field 'formalName'.
 void setId(java.lang.String id)
          Sets the value of field 'id'.
 void setLocalName(CsmfLocalName[] vLocalNameArray)
           
 void setLocalName(int index, CsmfLocalName vLocalName)
           
 void setLocalName(java.util.List<CsmfLocalName> vLocalNameList)
          Sets the value of '_localNameList' by copying the given Vector.
 void setLocalNameAsReference(java.util.List<CsmfLocalName> localNameList)
          Deprecated.  
 void setMappings(CsmfMappings mappings)
          Sets the value of field 'mappings'.
 void setRepresentsVersion(CsmfVersion representsVersion)
          Sets the value of field 'representsVersion'.
 void setSource(CsmfSource[] vSourceArray)
           
 void setSource(int index, CsmfSource vSource)
           
 void setSource(java.util.List<CsmfSource> vSourceList)
          Sets the value of '_sourceList' by copying the given Vector.
 void setSourceAsReference(java.util.List<CsmfSource> sourceList)
          Deprecated.  
static CodingSchemeManifest unmarshalCodingSchemeManifest(java.io.Reader reader)
          Method unmarshalCodingSchemeManifest.
 void validate()
           
 
Methods inherited from class org.mayo.edu.lgModel.LexGridBase
getParent, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodingSchemeManifest

public CodingSchemeManifest()
Method Detail

addLocalName

public void addLocalName(CsmfLocalName vLocalName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
vLocalName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addLocalName

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

addSource

public void addSource(CsmfSource vSource)
               throws java.lang.IndexOutOfBoundsException
Parameters:
vSource -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addSource

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

enumerateLocalName

public java.util.Enumeration<? extends CsmfLocalName> enumerateLocalName()
Method enumerateLocalName.

Returns:
an Enumeration over all possible elements of this collection

enumerateSource

public java.util.Enumeration<? extends CsmfSource> enumerateSource()
Method enumerateSource.

Returns:
an Enumeration over all possible elements of this collection

getAssociationDefinitions

public CsmfAssociationDefinition getAssociationDefinitions()
Returns the value of field 'associationDefinitions'.

Returns:
the value of field 'AssociationDefinitions'.

getCodingScheme

public CsmfCodingSchemeName getCodingScheme()
Returns the value of field 'codingScheme'. The field 'codingScheme' has the following description: An identifier for the coding scheme.

Returns:
the value of field 'CodingScheme'.

getCodingSchemeURI

public CsmfCodingSchemeURI getCodingSchemeURI()
Returns the value of field 'codingSchemeURI'. The field 'codingSchemeURI' has the following description: Registered name of the coding scheme.

Returns:
the value of field 'CodingSchemeURI'.

getCopyright

public CsmfText getCopyright()
Returns the value of field 'copyright'. The field 'copyright' has the following description: Copyright notice text.

Returns:
the value of field 'Copyright'.

getDefaultLanguage

public CsmfDefaultLanguage getDefaultLanguage()
Returns the value of field 'defaultLanguage'. The field 'defaultLanguage' has the following description: Local name of the language to use if not otherwise specified.

Returns:
the value of field 'DefaultLanguage'.

getEntityDescription

public CsmfEntityDescription getEntityDescription()
Returns the value of field 'entityDescription'. The field 'entityDescription' has the following description: Coding scheme description text.

Returns:
the value of field 'EntityDescription'.

getFormalName

public CsmfFormalName getFormalName()
Returns the value of field 'formalName'. The field 'formalName' has the following description: Official or published name of the coding scheme.

Returns:
the value of field 'FormalName'.

getId

public java.lang.String getId()
Returns the value of field 'id'. The field 'id' has the following description: The key for the coding scheme manifest values. Normally this identifier is coding scheme's namespace.

Returns:
the value of field 'Id'.

getLocalName

public CsmfLocalName getLocalName(int index)
                           throws java.lang.IndexOutOfBoundsException
Method getLocalName.

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

getLocalName

public CsmfLocalName[] getLocalName()
Method getLocalName.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

getLocalNameAsReference

public java.util.List<CsmfLocalName> getLocalNameAsReference()
Method getLocalNameAsReference.Returns a reference to '_localNameList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getLocalNameCount

public int getLocalNameCount()
Method getLocalNameCount.

Returns:
the size of this collection

getMappings

public CsmfMappings getMappings()
Returns the value of field 'mappings'.

Returns:
the value of field 'Mappings'.

getRepresentsVersion

public CsmfVersion getRepresentsVersion()
Returns the value of field 'representsVersion'. The field 'representsVersion' has the following description: The coding scheme version currently represented by this entity.

Returns:
the value of field 'RepresentsVersion'.

getSource

public CsmfSource getSource(int index)
                     throws java.lang.IndexOutOfBoundsException
Method getSource.

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

getSource

public CsmfSource[] getSource()
Method getSource.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

getSourceAsReference

public java.util.List<CsmfSource> getSourceAsReference()
Method getSourceAsReference.Returns a reference to '_sourceList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getSourceCount

public int getSourceCount()
Method getSourceCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iterateLocalName

public java.util.Iterator<? extends CsmfLocalName> iterateLocalName()
Method iterateLocalName.

Returns:
an Iterator over all possible elements in this collection

iterateSource

public java.util.Iterator<? extends CsmfSource> iterateSource()
Method iterateSource.

Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllLocalName

public void removeAllLocalName()

removeAllSource

public void removeAllSource()

removeLocalName

public boolean removeLocalName(CsmfLocalName vLocalName)
Method removeLocalName.

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

removeLocalNameAt

public CsmfLocalName removeLocalNameAt(int index)
Method removeLocalNameAt.

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

removeSource

public boolean removeSource(CsmfSource vSource)
Method removeSource.

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

removeSourceAt

public CsmfSource removeSourceAt(int index)
Method removeSourceAt.

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

setAssociationDefinitions

public void setAssociationDefinitions(CsmfAssociationDefinition associationDefinitions)
Sets the value of field 'associationDefinitions'.

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

setCodingScheme

public void setCodingScheme(CsmfCodingSchemeName codingScheme)
Sets the value of field 'codingScheme'. The field 'codingScheme' has the following description: An identifier for the coding scheme.

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

setCodingSchemeURI

public void setCodingSchemeURI(CsmfCodingSchemeURI codingSchemeURI)
Sets the value of field 'codingSchemeURI'. The field 'codingSchemeURI' has the following description: Registered name of the coding scheme.

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

setCopyright

public void setCopyright(CsmfText copyright)
Sets the value of field 'copyright'. The field 'copyright' has the following description: Copyright notice text.

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

setDefaultLanguage

public void setDefaultLanguage(CsmfDefaultLanguage defaultLanguage)
Sets the value of field 'defaultLanguage'. The field 'defaultLanguage' has the following description: Local name of the language to use if not otherwise specified.

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

setEntityDescription

public void setEntityDescription(CsmfEntityDescription entityDescription)
Sets the value of field 'entityDescription'. The field 'entityDescription' has the following description: Coding scheme description text.

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

setFormalName

public void setFormalName(CsmfFormalName formalName)
Sets the value of field 'formalName'. The field 'formalName' has the following description: Official or published name of the coding scheme.

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

setId

public void setId(java.lang.String id)
Sets the value of field 'id'. The field 'id' has the following description: The key for the coding scheme manifest values. Normally this identifier is coding scheme's namespace.

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

setLocalName

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

setLocalName

public void setLocalName(CsmfLocalName[] vLocalNameArray)
Parameters:
vLocalNameArray -

setLocalName

public void setLocalName(java.util.List<CsmfLocalName> vLocalNameList)
Sets the value of '_localNameList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vLocalNameList - the Vector to copy.

setLocalNameAsReference

public void setLocalNameAsReference(java.util.List<CsmfLocalName> localNameList)
Deprecated. 

Sets the value of '_localNameList' by setting it to the given Vector. No type checking is performed.

Parameters:
localNameList - the Vector to set.

setMappings

public void setMappings(CsmfMappings mappings)
Sets the value of field 'mappings'.

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

setRepresentsVersion

public void setRepresentsVersion(CsmfVersion representsVersion)
Sets the value of field 'representsVersion'. The field 'representsVersion' has the following description: The coding scheme version currently represented by this entity.

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

setSource

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

setSource

public void setSource(CsmfSource[] vSourceArray)
Parameters:
vSourceArray -

setSource

public void setSource(java.util.List<CsmfSource> vSourceList)
Sets the value of '_sourceList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vSourceList - the Vector to copy.

setSourceAsReference

public void setSourceAsReference(java.util.List<CsmfSource> sourceList)
Deprecated. 

Sets the value of '_sourceList' by setting it to the given Vector. No type checking is performed.

Parameters:
sourceList - the Vector to set.

unmarshalCodingSchemeManifest

public static CodingSchemeManifest unmarshalCodingSchemeManifest(java.io.Reader reader)
                                                          throws org.exolab.castor.xml.MarshalException,
                                                                 org.exolab.castor.xml.ValidationException
Method unmarshalCodingSchemeManifest.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.LexOnt.CodingSchemeManifest
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

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.