|
|||||||||
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.concepts.EntityDirectoryEntry
public class EntityDirectoryEntry
General information about an entity
Constructor Summary | |
---|---|
EntityDirectoryEntry()
|
Method Summary | |
---|---|
void |
addEntityInContext(EntityInContext vEntityInContext)
|
void |
addEntityInContext(int index,
EntityInContext vEntityInContext)
|
java.util.Enumeration<? extends EntityInContext> |
enumerateEntityInContext()
Method enumerateEntityInContext. |
EntityDescription |
getEntityDescription()
Returns the value of field 'entityDescription'. |
EntityId |
getEntityId()
Returns the value of field 'entityId'. |
EntityInContext[] |
getEntityInContext()
Method getEntityInContext.Returns the contents of the collection in an Array. |
EntityInContext |
getEntityInContext(int index)
Method getEntityInContext. |
java.util.List<EntityInContext> |
getEntityInContextAsReference()
Method getEntityInContextAsReference.Returns a reference to '_entityInContextList'. |
int |
getEntityInContextCount()
Method getEntityInContextCount. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends EntityInContext> |
iterateEntityInContext()
Method iterateEntityInContext. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllEntityInContext()
|
boolean |
removeEntityInContext(EntityInContext vEntityInContext)
Method removeEntityInContext. |
EntityInContext |
removeEntityInContextAt(int index)
Method removeEntityInContextAt. |
void |
setEntityDescription(EntityDescription entityDescription)
Sets the value of field 'entityDescription'. |
void |
setEntityId(EntityId entityId)
Sets the value of field 'entityId'. |
void |
setEntityInContext(EntityInContext[] vEntityInContextArray)
|
void |
setEntityInContext(int index,
EntityInContext vEntityInContext)
|
void |
setEntityInContext(java.util.List<EntityInContext> vEntityInContextList)
Sets the value of '_entityInContextList' by copying the given Vector. |
void |
setEntityInContextAsReference(java.util.List<EntityInContext> entityInContextList)
Deprecated. |
static EntityDirectoryEntry |
unmarshalEntityDirectoryEntry(java.io.Reader reader)
Method unmarshalEntityDirectoryEntry. |
void |
validate()
|
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 EntityDirectoryEntry()
Method Detail |
---|
public void addEntityInContext(EntityInContext vEntityInContext) throws java.lang.IndexOutOfBoundsException
vEntityInContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addEntityInContext(int index, EntityInContext vEntityInContext) throws java.lang.IndexOutOfBoundsException
index
- vEntityInContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends EntityInContext> enumerateEntityInContext()
public EntityDescription getEntityDescription()
public EntityId getEntityId()
public EntityInContext getEntityInContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic EntityInContext[] getEntityInContext()
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<EntityInContext> getEntityInContextAsReference()
public int getEntityInContextCount()
public boolean isValid()
public java.util.Iterator<? extends EntityInContext> iterateEntityInContext()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
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
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 removeAllEntityInContext()
public boolean removeEntityInContext(EntityInContext vEntityInContext)
vEntityInContext
-
public EntityInContext removeEntityInContextAt(int index)
index
-
public void setEntityDescription(EntityDescription entityDescription)
entityDescription
- the value of field
'entityDescription'.public void setEntityId(EntityId entityId)
entityId
- the value of field 'entityId'.public void setEntityInContext(int index, EntityInContext vEntityInContext) throws java.lang.IndexOutOfBoundsException
index
- vEntityInContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setEntityInContext(EntityInContext[] vEntityInContextArray)
vEntityInContextArray
- public void setEntityInContext(java.util.List<EntityInContext> vEntityInContextList)
vEntityInContextList
- the Vector to copy.public void setEntityInContextAsReference(java.util.List<EntityInContext> entityInContextList)
entityInContextList
- the Vector to set.public static EntityDirectoryEntry unmarshalEntityDirectoryEntry(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
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 |