|
|||||||||
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.PickListDefinition
public class PickListDefinition
An ordered list of entity codes and corresponding presentations drawn from a value domain.
Constructor Summary | |
---|---|
PickListDefinition()
|
Method Summary | |
---|---|
void |
addDefaultPickContext(int index,
java.lang.String vDefaultPickContext)
|
void |
addDefaultPickContext(java.lang.String vDefaultPickContext)
|
void |
addPickListEntryNode(int index,
PickListEntryNode vPickListEntryNode)
|
void |
addPickListEntryNode(PickListEntryNode vPickListEntryNode)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
java.util.Enumeration<java.lang.String> |
enumerateDefaultPickContext()
Method enumerateDefaultPickContext. |
java.util.Enumeration<PickListEntryNode> |
enumeratePickListEntryNode()
Method enumeratePickListEntryNode. |
java.util.Enumeration<Source> |
enumerateSource()
Method enumerateSource. |
java.lang.Boolean |
getCompleteDomain()
Returns the value of field 'completeDomain'. |
java.lang.String |
getDefaultEntityCodeNamespace()
Returns the value of field 'defaultEntityCodeNamespace'. |
java.lang.String |
getDefaultLanguage()
Returns the value of field 'defaultLanguage'. |
java.lang.String[] |
getDefaultPickContext()
Method getDefaultPickContext.Returns the contents of the collection in an Array. |
java.lang.String |
getDefaultPickContext(int index)
Method getDefaultPickContext. |
int |
getDefaultPickContextCount()
Method getDefaultPickContextCount. |
java.lang.String |
getDefaultSortOrder()
Returns the value of field 'defaultSortOrder'. |
PickListEntryNode[] |
getPickListEntryNode()
Method getPickListEntryNode.Returns the contents of the collection in an Array. |
PickListEntryNode |
getPickListEntryNode(int index)
Method getPickListEntryNode. |
int |
getPickListEntryNodeCount()
Method getPickListEntryNodeCount. |
java.lang.String |
getPickListId()
Returns the value of field 'pickListId'. |
Properties |
getProperties()
Returns the value of field 'properties'. |
java.lang.String |
getRepresentsValueDomain()
Returns the value of field 'representsValueDomain'. |
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.Boolean |
isCompleteDomain()
Returns the value of field 'completeDomain'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<java.lang.String> |
iterateDefaultPickContext()
Method iterateDefaultPickContext. |
java.util.Iterator<PickListEntryNode> |
iteratePickListEntryNode()
Method iteratePickListEntryNode. |
java.util.Iterator<Source> |
iterateSource()
Method iterateSource. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllDefaultPickContext()
|
void |
removeAllPickListEntryNode()
|
void |
removeAllSource()
|
boolean |
removeDefaultPickContext(java.lang.String vDefaultPickContext)
Method removeDefaultPickContext. |
java.lang.String |
removeDefaultPickContextAt(int index)
Method removeDefaultPickContextAt. |
boolean |
removePickListEntryNode(PickListEntryNode vPickListEntryNode)
Method removePickListEntryNode. |
PickListEntryNode |
removePickListEntryNodeAt(int index)
Method removePickListEntryNodeAt. |
boolean |
removeSource(Source vSource)
Method removeSource. |
Source |
removeSourceAt(int index)
Method removeSourceAt. |
void |
setCompleteDomain(java.lang.Boolean completeDomain)
Sets the value of field 'completeDomain'. |
void |
setDefaultEntityCodeNamespace(java.lang.String defaultEntityCodeNamespace)
Sets the value of field 'defaultEntityCodeNamespace'. |
void |
setDefaultLanguage(java.lang.String defaultLanguage)
Sets the value of field 'defaultLanguage'. |
void |
setDefaultPickContext(int index,
java.lang.String vDefaultPickContext)
|
void |
setDefaultPickContext(java.lang.String[] vDefaultPickContextArray)
|
void |
setDefaultSortOrder(java.lang.String defaultSortOrder)
Sets the value of field 'defaultSortOrder'. |
void |
setPickListEntryNode(int index,
PickListEntryNode vPickListEntryNode)
|
void |
setPickListEntryNode(PickListEntryNode[] vPickListEntryNodeArray)
|
void |
setPickListId(java.lang.String pickListId)
Sets the value of field 'pickListId'. |
void |
setProperties(Properties properties)
Sets the value of field 'properties'. |
void |
setRepresentsValueDomain(java.lang.String representsValueDomain)
Sets the value of field 'representsValueDomain'. |
void |
setSource(int index,
Source vSource)
|
void |
setSource(Source[] vSourceArray)
|
static PickListDefinition |
unmarshalPickListDefinition(java.io.Reader reader)
Method unmarshalPickListDefinition. |
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 PickListDefinition()
Method Detail |
---|
public void addDefaultPickContext(java.lang.String vDefaultPickContext) throws java.lang.IndexOutOfBoundsException
vDefaultPickContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefaultPickContext(int index, java.lang.String vDefaultPickContext) throws java.lang.IndexOutOfBoundsException
index
- vDefaultPickContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPickListEntryNode(PickListEntryNode vPickListEntryNode) throws java.lang.IndexOutOfBoundsException
vPickListEntryNode
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPickListEntryNode(int index, PickListEntryNode vPickListEntryNode) throws java.lang.IndexOutOfBoundsException
index
- vPickListEntryNode
-
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<java.lang.String> enumerateDefaultPickContext()
public java.util.Enumeration<PickListEntryNode> enumeratePickListEntryNode()
public java.util.Enumeration<Source> enumerateSource()
public java.lang.Boolean getCompleteDomain()
public java.lang.String getDefaultEntityCodeNamespace()
public java.lang.String getDefaultLanguage()
public java.lang.String getDefaultPickContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.lang.String[] getDefaultPickContext()
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 getDefaultPickContextCount()
public java.lang.String getDefaultSortOrder()
public PickListEntryNode getPickListEntryNode(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic PickListEntryNode[] getPickListEntryNode()
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 getPickListEntryNodeCount()
public java.lang.String getPickListId()
public Properties getProperties()
public java.lang.String getRepresentsValueDomain()
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.Boolean isCompleteDomain()
public boolean isValid()
isValid
in class VersionableAndDescribable
public java.util.Iterator<java.lang.String> iterateDefaultPickContext()
public java.util.Iterator<PickListEntryNode> iteratePickListEntryNode()
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 removeAllDefaultPickContext()
public void removeAllPickListEntryNode()
public void removeAllSource()
public boolean removeDefaultPickContext(java.lang.String vDefaultPickContext)
vDefaultPickContext
-
public java.lang.String removeDefaultPickContextAt(int index)
index
-
public boolean removePickListEntryNode(PickListEntryNode vPickListEntryNode)
vPickListEntryNode
-
public PickListEntryNode removePickListEntryNodeAt(int index)
index
-
public boolean removeSource(Source vSource)
vSource
-
public Source removeSourceAt(int index)
index
-
public void setCompleteDomain(java.lang.Boolean completeDomain)
completeDomain
- the value of field 'completeDomain'.public void setDefaultEntityCodeNamespace(java.lang.String defaultEntityCodeNamespace)
defaultEntityCodeNamespace
- the value of field
'defaultEntityCodeNamespace'.public void setDefaultLanguage(java.lang.String defaultLanguage)
defaultLanguage
- the value of field 'defaultLanguage'.public void setDefaultPickContext(int index, java.lang.String vDefaultPickContext) throws java.lang.IndexOutOfBoundsException
index
- vDefaultPickContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setDefaultPickContext(java.lang.String[] vDefaultPickContextArray)
vDefaultPickContextArray
- public void setDefaultSortOrder(java.lang.String defaultSortOrder)
defaultSortOrder
- the value of field 'defaultSortOrder'public void setPickListEntryNode(int index, PickListEntryNode vPickListEntryNode) throws java.lang.IndexOutOfBoundsException
index
- vPickListEntryNode
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setPickListEntryNode(PickListEntryNode[] vPickListEntryNodeArray)
vPickListEntryNodeArray
- public void setPickListId(java.lang.String pickListId)
pickListId
- the value of field 'pickListId'.public void setProperties(Properties properties)
properties
- the value of field 'properties'.public void setRepresentsValueDomain(java.lang.String representsValueDomain)
representsValueDomain
- the value of field
'representsValueDomain'.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 static PickListDefinition unmarshalPickListDefinition(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 |