|
|||||||||
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.REST.commonTypes.Versionable
org.LexGrid.REST.valueSets.ValueDomainDefinition
public class ValueDomainDefinition
A definition of a given value domain. A value domain can be a simple description with no associated value domain entries, or it can consist of one or more definitionEntries that resolve to an enumerated list of entityCodes when applied to one or more codingScheme versions.
Constructor Summary | |
---|---|
ValueDomainDefinition()
|
Method Summary | |
---|---|
void |
addDefinitionEntry(DefinitionEntry vDefinitionEntry)
|
void |
addDefinitionEntry(int index,
DefinitionEntry vDefinitionEntry)
|
void |
addRepresentsRealmOrContext(Context vRepresentsRealmOrContext)
|
void |
addRepresentsRealmOrContext(int index,
Context vRepresentsRealmOrContext)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
java.util.Enumeration<? extends DefinitionEntry> |
enumerateDefinitionEntry()
Method enumerateDefinitionEntry. |
java.util.Enumeration<? extends Context> |
enumerateRepresentsRealmOrContext()
Method enumerateRepresentsRealmOrContext. |
java.util.Enumeration<? extends Source> |
enumerateSource()
Method enumerateSource. |
CodingSchemeName |
getDefaultCodingScheme()
Returns the value of field 'defaultCodingScheme'. |
DefinitionEntry[] |
getDefinitionEntry()
Method getDefinitionEntry.Returns the contents of the collection in an Array. |
DefinitionEntry |
getDefinitionEntry(int index)
Method getDefinitionEntry. |
java.util.List<DefinitionEntry> |
getDefinitionEntryAsReference()
Method getDefinitionEntryAsReference.Returns a reference to '_definitionEntryList'. |
int |
getDefinitionEntryCount()
Method getDefinitionEntryCount. |
MappingsLink |
getMappings()
Returns the value of field 'mappings'. |
PropertiesLink |
getProperties()
Returns the value of field 'properties'. |
Context[] |
getRepresentsRealmOrContext()
Method getRepresentsRealmOrContext.Returns the contents of the collection in an Array. |
Context |
getRepresentsRealmOrContext(int index)
Method getRepresentsRealmOrContext. |
java.util.List<Context> |
getRepresentsRealmOrContextAsReference()
Method getRepresentsRealmOrContextAsReference.Returns a reference to '_representsRealmOrContextList'. |
int |
getRepresentsRealmOrContextCount()
Method getRepresentsRealmOrContextCount. |
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. |
ValueDomainDirectoryEntryGroup |
getValueDomainDirectoryEntryGroup()
Returns the value of field 'valueDomainDirectoryEntryGroup'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends DefinitionEntry> |
iterateDefinitionEntry()
Method iterateDefinitionEntry. |
java.util.Iterator<? extends Context> |
iterateRepresentsRealmOrContext()
Method iterateRepresentsRealmOrContext. |
java.util.Iterator<? extends Source> |
iterateSource()
Method iterateSource. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllDefinitionEntry()
|
void |
removeAllRepresentsRealmOrContext()
|
void |
removeAllSource()
|
boolean |
removeDefinitionEntry(DefinitionEntry vDefinitionEntry)
Method removeDefinitionEntry. |
DefinitionEntry |
removeDefinitionEntryAt(int index)
Method removeDefinitionEntryAt. |
boolean |
removeRepresentsRealmOrContext(Context vRepresentsRealmOrContext)
Method removeRepresentsRealmOrContext. |
Context |
removeRepresentsRealmOrContextAt(int index)
Method removeRepresentsRealmOrContextAt. |
boolean |
removeSource(Source vSource)
Method removeSource. |
Source |
removeSourceAt(int index)
Method removeSourceAt. |
void |
setDefaultCodingScheme(CodingSchemeName defaultCodingScheme)
Sets the value of field 'defaultCodingScheme'. |
void |
setDefinitionEntry(DefinitionEntry[] vDefinitionEntryArray)
|
void |
setDefinitionEntry(int index,
DefinitionEntry vDefinitionEntry)
|
void |
setDefinitionEntry(java.util.List<DefinitionEntry> vDefinitionEntryList)
Sets the value of '_definitionEntryList' by copying the given Vector. |
void |
setDefinitionEntryAsReference(java.util.List<DefinitionEntry> definitionEntryList)
Deprecated. |
void |
setMappings(MappingsLink mappings)
Sets the value of field 'mappings'. |
void |
setProperties(PropertiesLink properties)
Sets the value of field 'properties'. |
void |
setRepresentsRealmOrContext(Context[] vRepresentsRealmOrContextArray)
|
void |
setRepresentsRealmOrContext(int index,
Context vRepresentsRealmOrContext)
|
void |
setRepresentsRealmOrContext(java.util.List<Context> vRepresentsRealmOrContextList)
Sets the value of '_representsRealmOrContextList' by copying the given Vector. |
void |
setRepresentsRealmOrContextAsReference(java.util.List<Context> representsRealmOrContextList)
Deprecated. |
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. |
void |
setValueDomainDirectoryEntryGroup(ValueDomainDirectoryEntryGroup valueDomainDirectoryEntryGroup)
Sets the value of field 'valueDomainDirectoryEntryGroup'. |
static ValueDomainDefinition |
unmarshalValueDomainDefinition(java.io.Reader reader)
Method unmarshalValueDomainDefinition. |
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 |
---|
public ValueDomainDefinition()
Method Detail |
---|
public void addDefinitionEntry(DefinitionEntry vDefinitionEntry) throws java.lang.IndexOutOfBoundsException
vDefinitionEntry
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefinitionEntry(int index, DefinitionEntry vDefinitionEntry) throws java.lang.IndexOutOfBoundsException
index
- vDefinitionEntry
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addRepresentsRealmOrContext(Context vRepresentsRealmOrContext) throws java.lang.IndexOutOfBoundsException
vRepresentsRealmOrContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addRepresentsRealmOrContext(int index, Context vRepresentsRealmOrContext) throws java.lang.IndexOutOfBoundsException
index
- vRepresentsRealmOrContext
-
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 DefinitionEntry> enumerateDefinitionEntry()
public java.util.Enumeration<? extends Context> enumerateRepresentsRealmOrContext()
public java.util.Enumeration<? extends Source> enumerateSource()
public CodingSchemeName getDefaultCodingScheme()
public DefinitionEntry getDefinitionEntry(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic DefinitionEntry[] getDefinitionEntry()
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<DefinitionEntry> getDefinitionEntryAsReference()
public int getDefinitionEntryCount()
public MappingsLink getMappings()
public PropertiesLink getProperties()
public Context getRepresentsRealmOrContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Context[] getRepresentsRealmOrContext()
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<Context> getRepresentsRealmOrContextAsReference()
public int getRepresentsRealmOrContextCount()
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 ValueDomainDirectoryEntryGroup getValueDomainDirectoryEntryGroup()
public boolean isValid()
isValid
in class Versionable
public java.util.Iterator<? extends DefinitionEntry> iterateDefinitionEntry()
public java.util.Iterator<? extends Context> iterateRepresentsRealmOrContext()
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 Versionable
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 Versionable
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 removeAllDefinitionEntry()
public void removeAllRepresentsRealmOrContext()
public void removeAllSource()
public boolean removeDefinitionEntry(DefinitionEntry vDefinitionEntry)
vDefinitionEntry
-
public DefinitionEntry removeDefinitionEntryAt(int index)
index
-
public boolean removeRepresentsRealmOrContext(Context vRepresentsRealmOrContext)
vRepresentsRealmOrContext
-
public Context removeRepresentsRealmOrContextAt(int index)
index
-
public boolean removeSource(Source vSource)
vSource
-
public Source removeSourceAt(int index)
index
-
public void setDefaultCodingScheme(CodingSchemeName defaultCodingScheme)
defaultCodingScheme
- the value of field
'defaultCodingScheme'.public void setDefinitionEntry(int index, DefinitionEntry vDefinitionEntry) throws java.lang.IndexOutOfBoundsException
index
- vDefinitionEntry
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setDefinitionEntry(DefinitionEntry[] vDefinitionEntryArray)
vDefinitionEntryArray
- public void setDefinitionEntry(java.util.List<DefinitionEntry> vDefinitionEntryList)
vDefinitionEntryList
- the Vector to copy.public void setDefinitionEntryAsReference(java.util.List<DefinitionEntry> definitionEntryList)
definitionEntryList
- the Vector to set.public void setMappings(MappingsLink mappings)
mappings
- the value of field 'mappings'.public void setProperties(PropertiesLink properties)
properties
- the value of field 'properties'.public void setRepresentsRealmOrContext(int index, Context vRepresentsRealmOrContext) throws java.lang.IndexOutOfBoundsException
index
- vRepresentsRealmOrContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setRepresentsRealmOrContext(Context[] vRepresentsRealmOrContextArray)
vRepresentsRealmOrContextArray
- public void setRepresentsRealmOrContext(java.util.List<Context> vRepresentsRealmOrContextList)
vRepresentsRealmOrContextList
- the Vector to copy.public void setRepresentsRealmOrContextAsReference(java.util.List<Context> representsRealmOrContextList)
representsRealmOrContextList
- the Vector to set.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 void setValueDomainDirectoryEntryGroup(ValueDomainDirectoryEntryGroup valueDomainDirectoryEntryGroup)
valueDomainDirectoryEntryGroup
- the value of field
'valueDomainDirectoryEntryGroup'.public static ValueDomainDefinition unmarshalValueDomainDefinition(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 Versionable
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 |