|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.LexGrid.commonTypes.Versionable
org.LexGrid.commonTypes.VersionableAndDescribable
org.LexGrid.valueDomains.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.NOTE: Value domain definitions aren't versionable - changing the definition of the domain changes its identity.
Constructor Summary | |
---|---|
ValueDomainDefinition()
|
Method Summary | |
---|---|
void |
addDefinitionEntry(DefinitionEntry vDefinitionEntry)
|
void |
addDefinitionEntry(int index,
DefinitionEntry vDefinitionEntry)
|
void |
addRepresentsRealmOrContext(int index,
java.lang.String vRepresentsRealmOrContext)
|
void |
addRepresentsRealmOrContext(java.lang.String vRepresentsRealmOrContext)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
java.util.Enumeration<DefinitionEntry> |
enumerateDefinitionEntry()
Method enumerateDefinitionEntry. |
java.util.Enumeration<java.lang.String> |
enumerateRepresentsRealmOrContext()
Method enumerateRepresentsRealmOrContext. |
java.util.Enumeration<Source> |
enumerateSource()
Method enumerateSource. |
java.lang.String |
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. |
int |
getDefinitionEntryCount()
Method getDefinitionEntryCount. |
Mappings |
getMappings()
Returns the value of field 'mappings'. |
Properties |
getProperties()
Returns the value of field 'properties'. |
java.lang.String[] |
getRepresentsRealmOrContext()
Method getRepresentsRealmOrContext.Returns the contents of the collection in an Array. |
java.lang.String |
getRepresentsRealmOrContext(int index)
Method getRepresentsRealmOrContext. |
int |
getRepresentsRealmOrContextCount()
Method getRepresentsRealmOrContextCount. |
Source[] |
getSource()
Method getSource.Returns the contents of the collection in an Array. |
Source |
getSource(int index)
Method getSource. |
int |
getSourceCount()
Method getSourceCount. |
java.lang.String |
getValueDomainName()
Returns the value of field 'valueDomainName'. |
java.lang.String |
getValueDomainURI()
Returns the value of field 'valueDomainURI'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<DefinitionEntry> |
iterateDefinitionEntry()
Method iterateDefinitionEntry. |
java.util.Iterator<java.lang.String> |
iterateRepresentsRealmOrContext()
Method iterateRepresentsRealmOrContext. |
java.util.Iterator<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(java.lang.String vRepresentsRealmOrContext)
Method removeRepresentsRealmOrContext. |
java.lang.String |
removeRepresentsRealmOrContextAt(int index)
Method removeRepresentsRealmOrContextAt. |
boolean |
removeSource(Source vSource)
Method removeSource. |
Source |
removeSourceAt(int index)
Method removeSourceAt. |
void |
setDefaultCodingScheme(java.lang.String defaultCodingScheme)
Sets the value of field 'defaultCodingScheme'. |
void |
setDefinitionEntry(DefinitionEntry[] vDefinitionEntryArray)
|
void |
setDefinitionEntry(int index,
DefinitionEntry vDefinitionEntry)
|
void |
setMappings(Mappings mappings)
Sets the value of field 'mappings'. |
void |
setProperties(Properties properties)
Sets the value of field 'properties'. |
void |
setRepresentsRealmOrContext(int index,
java.lang.String vRepresentsRealmOrContext)
|
void |
setRepresentsRealmOrContext(java.lang.String[] vRepresentsRealmOrContextArray)
|
void |
setSource(int index,
Source vSource)
|
void |
setSource(Source[] vSourceArray)
|
void |
setValueDomainName(java.lang.String valueDomainName)
Sets the value of field 'valueDomainName'. |
void |
setValueDomainURI(java.lang.String valueDomainURI)
Sets the value of field 'valueDomainURI'. |
static ValueDomainDefinition |
unmarshalValueDomainDefinition(java.io.Reader reader)
Method unmarshalValueDomainDefinition. |
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 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(java.lang.String vRepresentsRealmOrContext) throws java.lang.IndexOutOfBoundsException
vRepresentsRealmOrContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addRepresentsRealmOrContext(int index, java.lang.String 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<DefinitionEntry> enumerateDefinitionEntry()
public java.util.Enumeration<java.lang.String> enumerateRepresentsRealmOrContext()
public java.util.Enumeration<Source> enumerateSource()
public java.lang.String 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 int getDefinitionEntryCount()
public Mappings getMappings()
public Properties getProperties()
public java.lang.String getRepresentsRealmOrContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.lang.String[] 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 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 int getSourceCount()
public java.lang.String getValueDomainName()
public java.lang.String getValueDomainURI()
public boolean isValid()
isValid
in class VersionableAndDescribable
public java.util.Iterator<DefinitionEntry> iterateDefinitionEntry()
public java.util.Iterator<java.lang.String> iterateRepresentsRealmOrContext()
public java.util.Iterator<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 removeAllDefinitionEntry()
public void removeAllRepresentsRealmOrContext()
public void removeAllSource()
public boolean removeDefinitionEntry(DefinitionEntry vDefinitionEntry)
vDefinitionEntry
-
public DefinitionEntry removeDefinitionEntryAt(int index)
index
-
public boolean removeRepresentsRealmOrContext(java.lang.String vRepresentsRealmOrContext)
vRepresentsRealmOrContext
-
public java.lang.String removeRepresentsRealmOrContextAt(int index)
index
-
public boolean removeSource(Source vSource)
vSource
-
public Source removeSourceAt(int index)
index
-
public void setDefaultCodingScheme(java.lang.String 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 setMappings(Mappings mappings)
mappings
- the value of field 'mappings'.public void setProperties(Properties properties)
properties
- the value of field 'properties'.public void setRepresentsRealmOrContext(int index, java.lang.String vRepresentsRealmOrContext) throws java.lang.IndexOutOfBoundsException
index
- vRepresentsRealmOrContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setRepresentsRealmOrContext(java.lang.String[] vRepresentsRealmOrContextArray)
vRepresentsRealmOrContextArray
- 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 setValueDomainName(java.lang.String valueDomainName)
valueDomainName
- the value of field 'valueDomainName'.public void setValueDomainURI(java.lang.String valueDomainURI)
valueDomainURI
- the value of field 'valueDomainURI'.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 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 |