|
|||||||||
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.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(Context vDefaultPickContext)
|
void |
addDefaultPickContext(int index,
Context vDefaultPickContext)
|
void |
addPickListEntryNode(int index,
PickListEntryNode vPickListEntryNode)
|
void |
addPickListEntryNode(PickListEntryNode vPickListEntryNode)
|
void |
addSource(int index,
Source vSource)
|
void |
addSource(Source vSource)
|
java.util.Enumeration<? extends Context> |
enumerateDefaultPickContext()
Method enumerateDefaultPickContext. |
java.util.Enumeration<? extends PickListEntryNode> |
enumeratePickListEntryNode()
Method enumeratePickListEntryNode. |
java.util.Enumeration<? extends Source> |
enumerateSource()
Method enumerateSource. |
java.lang.Boolean |
getCompleteDomain()
Returns the value of field 'completeDomain'. |
NamespaceName |
getDefaultEntityCodeNamespace()
Returns the value of field 'defaultEntityCodeNamespace'. |
Language |
getDefaultLanguage()
Returns the value of field 'defaultLanguage'. |
Context[] |
getDefaultPickContext()
Method getDefaultPickContext.Returns the contents of the collection in an Array. |
Context |
getDefaultPickContext(int index)
Method getDefaultPickContext. |
java.util.List<Context> |
getDefaultPickContextAsReference()
Method getDefaultPickContextAsReference.Returns a reference to '_defaultPickContextList'. |
int |
getDefaultPickContextCount()
Method getDefaultPickContextCount. |
SortOrder |
getDefaultSortOrder()
Returns the value of field 'defaultSortOrder'. |
Mappings |
getMappings()
Returns the value of field 'mappings'. |
PickListDirectoryEntryGroup |
getPickListDirectoryEntryGroup()
Returns the value of field 'pickListDirectoryEntryGroup'. |
PickListEntryNode[] |
getPickListEntryNode()
Method getPickListEntryNode.Returns the contents of the collection in an Array. |
PickListEntryNode |
getPickListEntryNode(int index)
Method getPickListEntryNode. |
java.util.List<PickListEntryNode> |
getPickListEntryNodeAsReference()
Method getPickListEntryNodeAsReference.Returns a reference to '_pickListEntryNodeList'. |
int |
getPickListEntryNodeCount()
Method getPickListEntryNodeCount. |
NodeId |
getPickListId()
Returns the value of field 'pickListId'. |
Properties |
getProperties()
Returns the value of field 'properties'. |
URI |
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. |
java.util.List<Source> |
getSourceAsReference()
Method getSourceAsReference.Returns a reference to '_sourceList'. |
int |
getSourceCount()
Method getSourceCount. |
java.lang.Boolean |
isCompleteDomain()
Returns the value of field 'completeDomain'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends Context> |
iterateDefaultPickContext()
Method iterateDefaultPickContext. |
java.util.Iterator<? extends PickListEntryNode> |
iteratePickListEntryNode()
Method iteratePickListEntryNode. |
java.util.Iterator<? extends 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(Context vDefaultPickContext)
Method removeDefaultPickContext. |
Context |
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(NamespaceName defaultEntityCodeNamespace)
Sets the value of field 'defaultEntityCodeNamespace'. |
void |
setDefaultLanguage(Language defaultLanguage)
Sets the value of field 'defaultLanguage'. |
void |
setDefaultPickContext(Context[] vDefaultPickContextArray)
|
void |
setDefaultPickContext(int index,
Context vDefaultPickContext)
|
void |
setDefaultPickContext(java.util.List<Context> vDefaultPickContextList)
Sets the value of '_defaultPickContextList' by copying the given Vector. |
void |
setDefaultPickContextAsReference(java.util.List<Context> defaultPickContextList)
Deprecated. |
void |
setDefaultSortOrder(SortOrder defaultSortOrder)
Sets the value of field 'defaultSortOrder'. |
void |
setMappings(Mappings mappings)
Sets the value of field 'mappings'. |
void |
setPickListDirectoryEntryGroup(PickListDirectoryEntryGroup pickListDirectoryEntryGroup)
Sets the value of field 'pickListDirectoryEntryGroup'. |
void |
setPickListEntryNode(int index,
PickListEntryNode vPickListEntryNode)
|
void |
setPickListEntryNode(java.util.List<PickListEntryNode> vPickListEntryNodeList)
Sets the value of '_pickListEntryNodeList' by copying the given Vector. |
void |
setPickListEntryNode(PickListEntryNode[] vPickListEntryNodeArray)
|
void |
setPickListEntryNodeAsReference(java.util.List<PickListEntryNode> pickListEntryNodeList)
Deprecated. |
void |
setPickListId(NodeId pickListId)
Sets the value of field 'pickListId'. |
void |
setProperties(Properties properties)
Sets the value of field 'properties'. |
void |
setRepresentsValueDomain(URI representsValueDomain)
Sets the value of field 'representsValueDomain'. |
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 PickListDefinition |
unmarshalPickListDefinition(java.io.Reader reader)
Method unmarshalPickListDefinition. |
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 PickListDefinition()
Method Detail |
---|
public void addDefaultPickContext(Context vDefaultPickContext) throws java.lang.IndexOutOfBoundsException
vDefaultPickContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefaultPickContext(int index, Context 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<? extends Context> enumerateDefaultPickContext()
public java.util.Enumeration<? extends PickListEntryNode> enumeratePickListEntryNode()
public java.util.Enumeration<? extends Source> enumerateSource()
public java.lang.Boolean getCompleteDomain()
public NamespaceName getDefaultEntityCodeNamespace()
public Language getDefaultLanguage()
public Context getDefaultPickContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Context[] 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 java.util.List<Context> getDefaultPickContextAsReference()
public int getDefaultPickContextCount()
public SortOrder getDefaultSortOrder()
public Mappings getMappings()
public PickListDirectoryEntryGroup getPickListDirectoryEntryGroup()
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 java.util.List<PickListEntryNode> getPickListEntryNodeAsReference()
public int getPickListEntryNodeCount()
public NodeId getPickListId()
public Properties getProperties()
public URI 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 java.util.List<Source> getSourceAsReference()
public int getSourceCount()
public java.lang.Boolean isCompleteDomain()
public boolean isValid()
isValid
in class Versionable
public java.util.Iterator<? extends Context> iterateDefaultPickContext()
public java.util.Iterator<? extends PickListEntryNode> iteratePickListEntryNode()
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 removeAllDefaultPickContext()
public void removeAllPickListEntryNode()
public void removeAllSource()
public boolean removeDefaultPickContext(Context vDefaultPickContext)
vDefaultPickContext
-
public Context 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(NamespaceName defaultEntityCodeNamespace)
defaultEntityCodeNamespace
- the value of field
'defaultEntityCodeNamespace'.public void setDefaultLanguage(Language defaultLanguage)
defaultLanguage
- the value of field 'defaultLanguage'.public void setDefaultPickContext(int index, Context vDefaultPickContext) throws java.lang.IndexOutOfBoundsException
index
- vDefaultPickContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setDefaultPickContext(Context[] vDefaultPickContextArray)
vDefaultPickContextArray
- public void setDefaultPickContext(java.util.List<Context> vDefaultPickContextList)
vDefaultPickContextList
- the Vector to copy.public void setDefaultPickContextAsReference(java.util.List<Context> defaultPickContextList)
defaultPickContextList
- the Vector to set.public void setDefaultSortOrder(SortOrder defaultSortOrder)
defaultSortOrder
- the value of field 'defaultSortOrder'public void setMappings(Mappings mappings)
mappings
- the value of field 'mappings'.public void setPickListDirectoryEntryGroup(PickListDirectoryEntryGroup pickListDirectoryEntryGroup)
pickListDirectoryEntryGroup
- the value of field
'pickListDirectoryEntryGroup'.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 setPickListEntryNode(java.util.List<PickListEntryNode> vPickListEntryNodeList)
vPickListEntryNodeList
- the Vector to copy.public void setPickListEntryNodeAsReference(java.util.List<PickListEntryNode> pickListEntryNodeList)
pickListEntryNodeList
- the Vector to set.public void setPickListId(NodeId pickListId)
pickListId
- the value of field 'pickListId'.public void setProperties(Properties properties)
properties
- the value of field 'properties'.public void setRepresentsValueDomain(URI 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 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 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 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 |