org.LexGrid.REST.codingSchemes
Class CodingScheme

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.commonTypes.Versionable
          extended by org.LexGrid.REST.codingSchemes.CodingScheme
All Implemented Interfaces:
java.io.Serializable

public class CodingScheme
extends Versionable
implements java.io.Serializable

A resource that makes assertions about a collection of terminological entities.

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

Constructor Summary
CodingScheme()
           
 
Method Summary
 java.lang.Long getApproxNumConcepts()
          Returns the value of field 'approxNumConcepts'.
 CodingSchemeDirectoryEntryGroup getCodingSchemeDirectoryEntryGroup()
          Returns the value of field 'codingSchemeDirectoryEntryGroup'.
 Text getCopyright()
          Returns the value of field 'copyright'.
 Language getDefaultLanguage()
          Returns the value of field 'defaultLanguage'.
 EntitiesLink getEntities()
          Returns the value of field 'entities'.
 LocalNames getLocalNames()
          Returns the value of field 'localNames'.
 MappingsLink getMappings()
          Returns the value of field 'mappings'.
 PropertiesLink getProperties()
          Returns the value of field 'properties'.
 RelationsLink getRelations()
          Returns the value of field 'relations'.
 Sources getSources()
          Returns the value of field 'sources'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setApproxNumConcepts(java.lang.Long approxNumConcepts)
          Sets the value of field 'approxNumConcepts'.
 void setCodingSchemeDirectoryEntryGroup(CodingSchemeDirectoryEntryGroup codingSchemeDirectoryEntryGroup)
          Sets the value of field 'codingSchemeDirectoryEntryGroup'.
 void setCopyright(Text copyright)
          Sets the value of field 'copyright'.
 void setDefaultLanguage(Language defaultLanguage)
          Sets the value of field 'defaultLanguage'.
 void setEntities(EntitiesLink entities)
          Sets the value of field 'entities'.
 void setLocalNames(LocalNames localNames)
          Sets the value of field 'localNames'.
 void setMappings(MappingsLink mappings)
          Sets the value of field 'mappings'.
 void setProperties(PropertiesLink properties)
          Sets the value of field 'properties'.
 void setRelations(RelationsLink relations)
          Sets the value of field 'relations'.
 void setSources(Sources sources)
          Sets the value of field 'sources'.
static CodingScheme unmarshalCodingScheme(java.io.Reader reader)
          Method unmarshalCodingScheme.
 void validate()
           
 
Methods inherited from class org.LexGrid.REST.commonTypes.Versionable
getEffectiveDate, getEntryState, getExpirationDate, getIsActive, getOwner, getStatus, isIsActive, setEffectiveDate, setEntryState, setExpirationDate, setIsActive, setOwner, setStatus, unmarshalVersionable
 
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

CodingScheme

public CodingScheme()
Method Detail

getApproxNumConcepts

public java.lang.Long getApproxNumConcepts()
Returns the value of field 'approxNumConcepts'. The field 'approxNumConcepts' has the following description: The approximate number of entries in the lexical portion of this scheme. This is used as a hint for browsers and services.

Returns:
the value of field 'ApproxNumConcepts'.

getCodingSchemeDirectoryEntryGroup

public CodingSchemeDirectoryEntryGroup getCodingSchemeDirectoryEntryGroup()
Returns the value of field 'codingSchemeDirectoryEntryGroup'.

Returns:
the value of field 'CodingSchemeDirectoryEntryGroup'.

getCopyright

public Text getCopyright()
Returns the value of field 'copyright'. The field 'copyright' has the following description: Information about rights held in and over the resource. Typically, copyright information includes a statement about various property rights associated with the resource, including intellectual property rights.

Returns:
the value of field 'Copyright'.

getDefaultLanguage

public Language getDefaultLanguage()
Returns the value of field 'defaultLanguage'. The field 'defaultLanguage' has the following description: The local identifier of the language that is used in all presentations, descriptions, etc. in this coding scheme if not otherwise specified. defaultLanguage must match a local id of a supportedLanguage in the mappings section.

Returns:
the value of field 'DefaultLanguage'.

getEntities

public EntitiesLink getEntities()
Returns the value of field 'entities'.

Returns:
the value of field 'Entities'.

getLocalNames

public LocalNames getLocalNames()
Returns the value of field 'localNames'. The field 'localNames' has the following description: Additional names that can be used to reference the coding scheme within the context of a given service.

Returns:
the value of field 'LocalNames'.

getMappings

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

Returns:
the value of field 'Mappings'.

getProperties

public PropertiesLink getProperties()
Returns the value of field 'properties'.

Returns:
the value of field 'Properties'.

getRelations

public RelationsLink getRelations()
Returns the value of field 'relations'.

Returns:
the value of field 'Relations'.

getSources

public Sources getSources()
Returns the value of field 'sources'. The field 'sources' has the following description: The local identifiers of the source(s) of this coding scheme. Must match a local id of a supportedSource in the corresponding mappings section.

Returns:
the value of field 'Sources'.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class Versionable
Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Overrides:
marshal in class Versionable
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
Overrides:
marshal in class Versionable
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

setApproxNumConcepts

public void setApproxNumConcepts(java.lang.Long approxNumConcepts)
Sets the value of field 'approxNumConcepts'. The field 'approxNumConcepts' has the following description: The approximate number of entries in the lexical portion of this scheme. This is used as a hint for browsers and services.

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

setCodingSchemeDirectoryEntryGroup

public void setCodingSchemeDirectoryEntryGroup(CodingSchemeDirectoryEntryGroup codingSchemeDirectoryEntryGroup)
Sets the value of field 'codingSchemeDirectoryEntryGroup'.

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

setCopyright

public void setCopyright(Text copyright)
Sets the value of field 'copyright'. The field 'copyright' has the following description: Information about rights held in and over the resource. Typically, copyright information includes a statement about various property rights associated with the resource, including intellectual property rights.

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

setDefaultLanguage

public void setDefaultLanguage(Language defaultLanguage)
Sets the value of field 'defaultLanguage'. The field 'defaultLanguage' has the following description: The local identifier of the language that is used in all presentations, descriptions, etc. in this coding scheme if not otherwise specified. defaultLanguage must match a local id of a supportedLanguage in the mappings section.

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

setEntities

public void setEntities(EntitiesLink entities)
Sets the value of field 'entities'.

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

setLocalNames

public void setLocalNames(LocalNames localNames)
Sets the value of field 'localNames'. The field 'localNames' has the following description: Additional names that can be used to reference the coding scheme within the context of a given service.

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

setMappings

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

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

setProperties

public void setProperties(PropertiesLink properties)
Sets the value of field 'properties'.

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

setRelations

public void setRelations(RelationsLink relations)
Sets the value of field 'relations'.

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

setSources

public void setSources(Sources sources)
Sets the value of field 'sources'. The field 'sources' has the following description: The local identifiers of the source(s) of this coding scheme. Must match a local id of a supportedSource in the corresponding mappings section.

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

unmarshalCodingScheme

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.codingSchemes.CodingScheme
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
Overrides:
validate in class Versionable
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.