|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mayo.edu.lgModel.LexGridBase
org.LexGrid.commonTypes.Versionable
org.LexGrid.commonTypes.VersionableAndDescribable
org.LexGrid.codingSchemes.CodingScheme
public class CodingScheme
A resource that makes assertions about a collection of terminological entities.
Constructor Summary | |
---|---|
CodingScheme()
|
Method Summary | |
---|---|
void |
addLocalName(int index,
java.lang.String vLocalName)
|
void |
addLocalName(java.lang.String vLocalName)
|
void |
addRelations(int index,
Relations vRelations)
|
void |
addRelations(Relations vRelations)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
java.util.Enumeration<? extends java.lang.String> |
enumerateLocalName()
Method enumerateLocalName. |
java.util.Enumeration<? extends Relations> |
enumerateRelations()
Method enumerateRelations. |
java.util.Enumeration<? extends Source> |
enumerateSource()
Method enumerateSource. |
java.lang.Long |
getApproxNumConcepts()
Returns the value of field 'approxNumConcepts'. |
java.lang.String |
getCodingSchemeName()
Returns the value of field 'codingSchemeName'. |
java.lang.String |
getCodingSchemeURI()
Returns the value of field 'codingSchemeURI'. |
Text |
getCopyright()
Returns the value of field 'copyright'. |
java.lang.String |
getDefaultLanguage()
Returns the value of field 'defaultLanguage'. |
Entities |
getEntities()
Returns the value of field 'entities'. |
java.lang.String |
getFormalName()
Returns the value of field 'formalName'. |
java.lang.String[] |
getLocalName()
Method getLocalName.Returns the contents of the collection in an Array. |
java.lang.String |
getLocalName(int index)
Method getLocalName. |
java.util.List<java.lang.String> |
getLocalNameAsReference()
Method getLocalNameAsReference.Returns a reference to '_localNameList'. |
int |
getLocalNameCount()
Method getLocalNameCount. |
Mappings |
getMappings()
Returns the value of field 'mappings'. |
Properties |
getProperties()
Returns the value of field 'properties'. |
Relations[] |
getRelations()
Method getRelations.Returns the contents of the collection in an Array. |
Relations |
getRelations(int index)
Method getRelations. |
java.util.List<Relations> |
getRelationsAsReference()
Method getRelationsAsReference.Returns a reference to '_relationsList'. |
int |
getRelationsCount()
Method getRelationsCount. |
java.lang.String |
getRepresentsVersion()
Returns the value of field 'representsVersion'. |
Source[] |
getSource()
Method getSource.Returns the contents of the collection in an Array. |
Source |
getSource(int index)
Method getSource. |
java.util.List<Source> |
getSourceAsReference()
Method getSourceAsReference.Returns a reference to '_sourceList'. |
int |
getSourceCount()
Method getSourceCount. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends java.lang.String> |
iterateLocalName()
Method iterateLocalName. |
java.util.Iterator<? extends Relations> |
iterateRelations()
Method iterateRelations. |
java.util.Iterator<? extends Source> |
iterateSource()
Method iterateSource. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllLocalName()
|
void |
removeAllRelations()
|
void |
removeAllSource()
|
boolean |
removeLocalName(java.lang.String vLocalName)
Method removeLocalName. |
java.lang.String |
removeLocalNameAt(int index)
Method removeLocalNameAt. |
boolean |
removeRelations(Relations vRelations)
Method removeRelations. |
Relations |
removeRelationsAt(int index)
Method removeRelationsAt. |
boolean |
removeSource(Source vSource)
Method removeSource. |
Source |
removeSourceAt(int index)
Method removeSourceAt. |
void |
setApproxNumConcepts(java.lang.Long approxNumConcepts)
Sets the value of field 'approxNumConcepts'. |
void |
setCodingSchemeName(java.lang.String codingSchemeName)
Sets the value of field 'codingSchemeName'. |
void |
setCodingSchemeURI(java.lang.String codingSchemeURI)
Sets the value of field 'codingSchemeURI'. |
void |
setCopyright(Text copyright)
Sets the value of field 'copyright'. |
void |
setDefaultLanguage(java.lang.String defaultLanguage)
Sets the value of field 'defaultLanguage'. |
void |
setEntities(Entities entities)
Sets the value of field 'entities'. |
void |
setFormalName(java.lang.String formalName)
Sets the value of field 'formalName'. |
void |
setLocalName(int index,
java.lang.String vLocalName)
|
void |
setLocalName(java.util.List<java.lang.String> vLocalNameList)
Sets the value of '_localNameList' by copying the given Vector. |
void |
setLocalName(java.lang.String[] vLocalNameArray)
|
void |
setLocalNameAsReference(java.util.List<java.lang.String> localNameList)
Deprecated. |
void |
setMappings(Mappings mappings)
Sets the value of field 'mappings'. |
void |
setProperties(Properties properties)
Sets the value of field 'properties'. |
void |
setRelations(int index,
Relations vRelations)
|
void |
setRelations(java.util.List<Relations> vRelationsList)
Sets the value of '_relationsList' by copying the given Vector. |
void |
setRelations(Relations[] vRelationsArray)
|
void |
setRelationsAsReference(java.util.List<Relations> relationsList)
Deprecated. |
void |
setRepresentsVersion(java.lang.String representsVersion)
Sets the value of field 'representsVersion'. |
void |
setSource(int index,
Source vSource)
|
void |
setSource(java.util.List<Source> vSourceList)
Sets the value of '_sourceList' by copying the given Vector. |
void |
setSource(Source[] vSourceArray)
|
void |
setSourceAsReference(java.util.List<Source> sourceList)
Deprecated. |
static CodingScheme |
unmarshalCodingScheme(java.io.Reader reader)
Method unmarshalCodingScheme. |
void |
validate()
|
Methods inherited from class org.LexGrid.commonTypes.VersionableAndDescribable |
---|
getEntityDescription, setEntityDescription, unmarshalVersionableAndDescribable |
Methods inherited from class org.LexGrid.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 |
---|
public CodingScheme()
Method Detail |
---|
public void addLocalName(java.lang.String vLocalName) throws java.lang.IndexOutOfBoundsException
vLocalName
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addLocalName(int index, java.lang.String vLocalName) throws java.lang.IndexOutOfBoundsException
index
- vLocalName
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addRelations(Relations vRelations) throws java.lang.IndexOutOfBoundsException
vRelations
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addRelations(int index, Relations vRelations) throws java.lang.IndexOutOfBoundsException
index
- vRelations
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addSource(Source vSource) throws java.lang.IndexOutOfBoundsException
vSource
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addSource(int index, Source vSource) throws java.lang.IndexOutOfBoundsException
index
- vSource
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends java.lang.String> enumerateLocalName()
public java.util.Enumeration<? extends Relations> enumerateRelations()
public java.util.Enumeration<? extends Source> enumerateSource()
public java.lang.Long getApproxNumConcepts()
public java.lang.String getCodingSchemeName()
public java.lang.String getCodingSchemeURI()
public Text getCopyright()
public java.lang.String getDefaultLanguage()
public Entities getEntities()
public java.lang.String getFormalName()
public java.lang.String getLocalName(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.lang.String[] getLocalName()
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.
public java.util.List<java.lang.String> getLocalNameAsReference()
public int getLocalNameCount()
public Mappings getMappings()
public Properties getProperties()
public Relations getRelations(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Relations[] getRelations()
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.
public java.util.List<Relations> getRelationsAsReference()
public int getRelationsCount()
public java.lang.String getRepresentsVersion()
public Source getSource(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Source[] getSource()
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.
public java.util.List<Source> getSourceAsReference()
public int getSourceCount()
public boolean isValid()
isValid
in class VersionableAndDescribable
public java.util.Iterator<? extends java.lang.String> iterateLocalName()
public java.util.Iterator<? extends Relations> iterateRelations()
public java.util.Iterator<? extends Source> iterateSource()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class VersionableAndDescribable
out
-
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 schemapublic void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class VersionableAndDescribable
handler
-
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 marshalingpublic void removeAllLocalName()
public void removeAllRelations()
public void removeAllSource()
public boolean removeLocalName(java.lang.String vLocalName)
vLocalName
-
public java.lang.String removeLocalNameAt(int index)
index
-
public boolean removeRelations(Relations vRelations)
vRelations
-
public Relations removeRelationsAt(int index)
index
-
public boolean removeSource(Source vSource)
vSource
-
public Source removeSourceAt(int index)
index
-
public void setApproxNumConcepts(java.lang.Long approxNumConcepts)
approxNumConcepts
- the value of field
'approxNumConcepts'.public void setCodingSchemeName(java.lang.String codingSchemeName)
codingSchemeName
- the value of field 'codingSchemeName'public void setCodingSchemeURI(java.lang.String codingSchemeURI)
codingSchemeURI
- the value of field 'codingSchemeURI'.public void setCopyright(Text copyright)
copyright
- the value of field 'copyright'.public void setDefaultLanguage(java.lang.String defaultLanguage)
defaultLanguage
- the value of field 'defaultLanguage'.public void setEntities(Entities entities)
entities
- the value of field 'entities'.public void setFormalName(java.lang.String formalName)
formalName
- the value of field 'formalName'.public void setLocalName(int index, java.lang.String vLocalName) throws java.lang.IndexOutOfBoundsException
index
- vLocalName
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setLocalName(java.lang.String[] vLocalNameArray)
vLocalNameArray
- public void setLocalName(java.util.List<java.lang.String> vLocalNameList)
vLocalNameList
- the Vector to copy.public void setLocalNameAsReference(java.util.List<java.lang.String> localNameList)
localNameList
- the Vector to set.public void setMappings(Mappings mappings)
mappings
- the value of field 'mappings'.public void setProperties(Properties properties)
properties
- the value of field 'properties'.public void setRelations(int index, Relations vRelations) throws java.lang.IndexOutOfBoundsException
index
- vRelations
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setRelations(Relations[] vRelationsArray)
vRelationsArray
- public void setRelations(java.util.List<Relations> vRelationsList)
vRelationsList
- the Vector to copy.public void setRelationsAsReference(java.util.List<Relations> relationsList)
relationsList
- the Vector to set.public void setRepresentsVersion(java.lang.String representsVersion)
representsVersion
- the value of field
'representsVersion'.public void setSource(int index, Source vSource) throws java.lang.IndexOutOfBoundsException
index
- vSource
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setSource(Source[] vSourceArray)
vSourceArray
- public void setSource(java.util.List<Source> vSourceList)
vSourceList
- the Vector to copy.public void setSourceAsReference(java.util.List<Source> sourceList)
sourceList
- the Vector to set.public static CodingScheme unmarshalCodingScheme(java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
reader
-
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 schemapublic void validate() throws org.exolab.castor.xml.ValidationException
validate
in class VersionableAndDescribable
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |