org.LexGrid.REST.concepts
Class EntityDirectoryEntry

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.concepts.EntityDirectoryEntry
All Implemented Interfaces:
java.io.Serializable

public class EntityDirectoryEntry
extends LexGridBase
implements java.io.Serializable

General information about an entity

Version:
$Revision$ $Date$
See Also:
Serialized Form

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

EntityDirectoryEntry

public EntityDirectoryEntry()
Method Detail

addEntityInContext

public void addEntityInContext(EntityInContext vEntityInContext)
                        throws java.lang.IndexOutOfBoundsException
Parameters:
vEntityInContext -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addEntityInContext

public void addEntityInContext(int index,
                               EntityInContext vEntityInContext)
                        throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vEntityInContext -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateEntityInContext

public java.util.Enumeration<? extends EntityInContext> enumerateEntityInContext()
Method enumerateEntityInContext.

Returns:
an Enumeration over all possible elements of this collection

getEntityDescription

public EntityDescription getEntityDescription()
Returns the value of field 'entityDescription'. The field 'entityDescription' has the following description: Text that represents the intent of this entity. Usually the preferred name

Returns:
the value of field 'EntityDescription'.

getEntityId

public EntityId getEntityId()
Returns the value of field 'entityId'. The field 'entityId' has the following description: The globally unique entity identifier

Returns:
the value of field 'EntityId'.

getEntityInContext

public EntityInContext getEntityInContext(int index)
                                   throws java.lang.IndexOutOfBoundsException
Method getEntityInContext.

Parameters:
index -
Returns:
the value of the org.LexGrid.REST.concepts.EntityInContext at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getEntityInContext

public EntityInContext[] getEntityInContext()
Method getEntityInContext.Returns the contents of the collection in an Array.

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.

Returns:
this collection as an Array

getEntityInContextAsReference

public java.util.List<EntityInContext> getEntityInContextAsReference()
Method getEntityInContextAsReference.Returns a reference to '_entityInContextList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getEntityInContextCount

public int getEntityInContextCount()
Method getEntityInContextCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iterateEntityInContext

public java.util.Iterator<? extends EntityInContext> iterateEntityInContext()
Method iterateEntityInContext.

Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
out -
Throws:
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 schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Parameters:
handler -
Throws:
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 marshaling

removeAllEntityInContext

public void removeAllEntityInContext()

removeEntityInContext

public boolean removeEntityInContext(EntityInContext vEntityInContext)
Method removeEntityInContext.

Parameters:
vEntityInContext -
Returns:
true if the object was removed from the collection.

removeEntityInContextAt

public EntityInContext removeEntityInContextAt(int index)
Method removeEntityInContextAt.

Parameters:
index -
Returns:
the element removed from the collection

setEntityDescription

public void setEntityDescription(EntityDescription entityDescription)
Sets the value of field 'entityDescription'. The field 'entityDescription' has the following description: Text that represents the intent of this entity. Usually the preferred name

Parameters:
entityDescription - the value of field 'entityDescription'.

setEntityId

public void setEntityId(EntityId entityId)
Sets the value of field 'entityId'. The field 'entityId' has the following description: The globally unique entity identifier

Parameters:
entityId - the value of field 'entityId'.

setEntityInContext

public void setEntityInContext(int index,
                               EntityInContext vEntityInContext)
                        throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vEntityInContext -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setEntityInContext

public void setEntityInContext(EntityInContext[] vEntityInContextArray)
Parameters:
vEntityInContextArray -

setEntityInContext

public void setEntityInContext(java.util.List<EntityInContext> vEntityInContextList)
Sets the value of '_entityInContextList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vEntityInContextList - the Vector to copy.

setEntityInContextAsReference

public void setEntityInContextAsReference(java.util.List<EntityInContext> entityInContextList)
Deprecated. 

Sets the value of '_entityInContextList' by setting it to the given Vector. No type checking is performed.

Parameters:
entityInContextList - the Vector to set.

unmarshalEntityDirectoryEntry

public static EntityDirectoryEntry unmarshalEntityDirectoryEntry(java.io.Reader reader)
                                                          throws org.exolab.castor.xml.MarshalException,
                                                                 org.exolab.castor.xml.ValidationException
Method unmarshalEntityDirectoryEntry.

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.concepts.EntityDirectoryEntry
Throws:
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 schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Throws:
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.