org.LexGrid.concepts
Class Entity

java.lang.Object
  extended by org.LexGrid.commonTypes.Versionable
      extended by org.LexGrid.commonTypes.VersionableAndDescribable
          extended by org.LexGrid.concepts.Entity
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Association, Concept, Instance

public class Entity
extends VersionableAndDescribable
implements java.io.Serializable

A set of lexical assertions about the intended meaning of a particular entity code.

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

Constructor Summary
Entity()
           
 
Method Summary
 void addAnyProperties(java.util.List<Property> properties)
          Adds all of the Properties (or subclasses of Property) in a given List to this Entity.
 void addAnyProperty(Property property)
          Adds any Property to this Entity.
 void addComment(Comment vComment)
           
 void addComment(int index, Comment vComment)
           
 void addDefinition(Definition vDefinition)
           
 void addDefinition(int index, Definition vDefinition)
           
 void addEntityType(int index, java.lang.String vEntityType)
           
 void addEntityType(java.lang.String vEntityType)
           
 void addPresentation(int index, Presentation vPresentation)
           
 void addPresentation(Presentation vPresentation)
           
 void addProperty(int index, Property vProperty)
           
 void addProperty(Property vProperty)
           
 void addPropertyLink(int index, PropertyLink vPropertyLink)
           
 void addPropertyLink(PropertyLink vPropertyLink)
           
 java.util.Enumeration<Comment> enumerateComment()
          Method enumerateComment.
 java.util.Enumeration<Definition> enumerateDefinition()
          Method enumerateDefinition.
 java.util.Enumeration<java.lang.String> enumerateEntityType()
          Method enumerateEntityType.
 java.util.Enumeration<Presentation> enumeratePresentation()
          Method enumeratePresentation.
 java.util.Enumeration<Property> enumerateProperty()
          Method enumerateProperty.
 java.util.Enumeration<PropertyLink> enumeratePropertyLink()
          Method enumeratePropertyLink.
 Property[] getAllProperties()
          Returns all of the Properties (and subclasses of Property) contained by this Entity.
 Comment[] getComment()
          Method getComment.Returns the contents of the collection in an Array.
 Comment getComment(int index)
          Method getComment.
 int getCommentCount()
          Method getCommentCount.
 Definition[] getDefinition()
          Method getDefinition.Returns the contents of the collection in an Array.
 Definition getDefinition(int index)
          Method getDefinition.
 int getDefinitionCount()
          Method getDefinitionCount.
 java.lang.String getEntityCode()
          Returns the value of field 'entityCode'.
 java.lang.String getEntityCodeNamespace()
          Returns the value of field 'entityCodeNamespace'.
 java.lang.String[] getEntityType()
          Method getEntityType.Returns the contents of the collection in an Array.
 java.lang.String getEntityType(int index)
          Method getEntityType.
 int getEntityTypeCount()
          Method getEntityTypeCount.
 java.lang.Boolean getIsAnonymous()
          Returns the value of field 'isAnonymous'.
 java.lang.Boolean getIsDefined()
          Returns the value of field 'isDefined'.
 Presentation[] getPresentation()
          Method getPresentation.Returns the contents of the collection in an Array.
 Presentation getPresentation(int index)
          Method getPresentation.
 int getPresentationCount()
          Method getPresentationCount.
 Property[] getProperty()
          Method getProperty.Returns the contents of the collection in an Array.
 Property getProperty(int index)
          Method getProperty.
 int getPropertyCount()
          Method getPropertyCount.
 PropertyLink[] getPropertyLink()
          Method getPropertyLink.Returns the contents of the collection in an Array.
 PropertyLink getPropertyLink(int index)
          Method getPropertyLink.
 int getPropertyLinkCount()
          Method getPropertyLinkCount.
 java.lang.Boolean isIsAnonymous()
          Returns the value of field 'isAnonymous'.
 java.lang.Boolean isIsDefined()
          Returns the value of field 'isDefined'.
 boolean isValid()
          Method isValid.
 java.util.Iterator<Comment> iterateComment()
          Method iterateComment.
 java.util.Iterator<Definition> iterateDefinition()
          Method iterateDefinition.
 java.util.Iterator<java.lang.String> iterateEntityType()
          Method iterateEntityType.
 java.util.Iterator<Presentation> iteratePresentation()
          Method iteratePresentation.
 java.util.Iterator<Property> iterateProperty()
          Method iterateProperty.
 java.util.Iterator<PropertyLink> iteratePropertyLink()
          Method iteratePropertyLink.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllComment()
           
 void removeAllDefinition()
           
 void removeAllEntityType()
           
 void removeAllPresentation()
           
 void removeAllProperty()
           
 void removeAllPropertyLink()
           
 boolean removeComment(Comment vComment)
          Method removeComment.
 Comment removeCommentAt(int index)
          Method removeCommentAt.
 boolean removeDefinition(Definition vDefinition)
          Method removeDefinition.
 Definition removeDefinitionAt(int index)
          Method removeDefinitionAt.
 boolean removeEntityType(java.lang.String vEntityType)
          Method removeEntityType.
 java.lang.String removeEntityTypeAt(int index)
          Method removeEntityTypeAt.
 boolean removePresentation(Presentation vPresentation)
          Method removePresentation.
 Presentation removePresentationAt(int index)
          Method removePresentationAt.
 boolean removeProperty(Property vProperty)
          Method removeProperty.
 Property removePropertyAt(int index)
          Method removePropertyAt.
 boolean removePropertyLink(PropertyLink vPropertyLink)
          Method removePropertyLink.
 PropertyLink removePropertyLinkAt(int index)
          Method removePropertyLinkAt.
 void setComment(Comment[] vCommentArray)
           
 void setComment(int index, Comment vComment)
           
 void setDefinition(Definition[] vDefinitionArray)
           
 void setDefinition(int index, Definition vDefinition)
           
 void setEntityCode(java.lang.String entityCode)
          Sets the value of field 'entityCode'.
 void setEntityCodeNamespace(java.lang.String entityCodeNamespace)
          Sets the value of field 'entityCodeNamespace'.
 void setEntityType(int index, java.lang.String vEntityType)
           
 void setEntityType(java.lang.String[] vEntityTypeArray)
           
 void setIsAnonymous(java.lang.Boolean isAnonymous)
          Sets the value of field 'isAnonymous'.
 void setIsDefined(java.lang.Boolean isDefined)
          Sets the value of field 'isDefined'.
 void setPresentation(int index, Presentation vPresentation)
           
 void setPresentation(Presentation[] vPresentationArray)
           
 void setProperty(int index, Property vProperty)
           
 void setProperty(Property[] vPropertyArray)
           
 void setPropertyLink(int index, PropertyLink vPropertyLink)
           
 void setPropertyLink(PropertyLink[] vPropertyLinkArray)
           
static Entity unmarshalEntity(java.io.Reader reader)
          Method unmarshalEntity.
 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

Entity

public Entity()
Method Detail

addComment

public void addComment(Comment vComment)
                throws java.lang.IndexOutOfBoundsException
Parameters:
vComment -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addComment

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

addDefinition

public void addDefinition(Definition vDefinition)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
vDefinition -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addDefinition

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

addEntityType

public void addEntityType(java.lang.String vEntityType)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
vEntityType -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addEntityType

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

addPresentation

public void addPresentation(Presentation vPresentation)
                     throws java.lang.IndexOutOfBoundsException
Parameters:
vPresentation -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPresentation

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

addProperty

public void addProperty(Property vProperty)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vProperty -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addProperty

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

addPropertyLink

public void addPropertyLink(PropertyLink vPropertyLink)
                     throws java.lang.IndexOutOfBoundsException
Parameters:
vPropertyLink -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPropertyLink

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

enumerateComment

public java.util.Enumeration<Comment> enumerateComment()
Method enumerateComment.

Returns:
an Enumeration over all possible elements of this collection

enumerateDefinition

public java.util.Enumeration<Definition> enumerateDefinition()
Method enumerateDefinition.

Returns:
an Enumeration over all possible elements of this collection

enumerateEntityType

public java.util.Enumeration<java.lang.String> enumerateEntityType()
Method enumerateEntityType.

Returns:
an Enumeration over all possible elements of this collection

enumeratePresentation

public java.util.Enumeration<Presentation> enumeratePresentation()
Method enumeratePresentation.

Returns:
an Enumeration over all possible elements of this collection

enumerateProperty

public java.util.Enumeration<Property> enumerateProperty()
Method enumerateProperty.

Returns:
an Enumeration over all possible elements of this collection

enumeratePropertyLink

public java.util.Enumeration<PropertyLink> enumeratePropertyLink()
Method enumeratePropertyLink.

Returns:
an Enumeration over all possible elements of this collection

getComment

public Comment getComment(int index)
                   throws java.lang.IndexOutOfBoundsException
Method getComment.

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

getComment

public Comment[] getComment()
Method getComment.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

getCommentCount

public int getCommentCount()
Method getCommentCount.

Returns:
the size of this collection

getDefinition

public Definition getDefinition(int index)
                         throws java.lang.IndexOutOfBoundsException
Method getDefinition.

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

getDefinition

public Definition[] getDefinition()
Method getDefinition.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

getDefinitionCount

public int getDefinitionCount()
Method getDefinitionCount.

Returns:
the size of this collection

getEntityCode

public java.lang.String getEntityCode()
Returns the value of field 'entityCode'. The field 'entityCode' has the following description: The entity code being defined.

Returns:
the value of field 'EntityCode'.

getEntityCodeNamespace

public java.lang.String getEntityCodeNamespace()
Returns the value of field 'entityCodeNamespace'. The field 'entityCodeNamespace' has the following description: Local identifier of the namespace of the entityCode. entityCodeNamespace must match a local id of a supportedNamespace in the corresponding mappings section. If omitted, the URI of the defaultCodingScheme will be used as the namespace for the entity code.

Returns:
the value of field 'EntityCodeNamespace'.

getEntityType

public java.lang.String getEntityType(int index)
                               throws java.lang.IndexOutOfBoundsException
Method getEntityType.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getEntityType

public java.lang.String[] getEntityType()
Method getEntityType.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

getEntityTypeCount

public int getEntityTypeCount()
Method getEntityTypeCount.

Returns:
the size of this collection

getIsAnonymous

public java.lang.Boolean getIsAnonymous()
Returns the value of field 'isAnonymous'. The field 'isAnonymous' has the following description: True means that the entityCode is synthetic, and doesn't actually exist in the namespace. isAnonymous is used for synthetic top and bottom nodes as well as blank or anonymous inner class definitions. Default: False

Returns:
the value of field 'IsAnonymous'.

getIsDefined

public java.lang.Boolean getIsDefined()
Returns the value of field 'isDefined'. The field 'isDefined' has the following description: True means that this entityCode is considered to be completely defined (i.e. necessary and sufficient) within the context of the containing code system. False means that only the necessary components are present. If omitted, the state of the entityCode definition is not known.

Returns:
the value of field 'IsDefined'.

getPresentation

public Presentation getPresentation(int index)
                             throws java.lang.IndexOutOfBoundsException
Method getPresentation.

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

getPresentation

public Presentation[] getPresentation()
Method getPresentation.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

getPresentationCount

public int getPresentationCount()
Method getPresentationCount.

Returns:
the size of this collection

getProperty

public Property getProperty(int index)
                     throws java.lang.IndexOutOfBoundsException
Method getProperty.

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

getProperty

public Property[] getProperty()
Method getProperty.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

getPropertyCount

public int getPropertyCount()
Method getPropertyCount.

Returns:
the size of this collection

getPropertyLink

public PropertyLink getPropertyLink(int index)
                             throws java.lang.IndexOutOfBoundsException
Method getPropertyLink.

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

getPropertyLink

public PropertyLink[] getPropertyLink()
Method getPropertyLink.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

getPropertyLinkCount

public int getPropertyLinkCount()
Method getPropertyLinkCount.

Returns:
the size of this collection

isIsAnonymous

public java.lang.Boolean isIsAnonymous()
Returns the value of field 'isAnonymous'. The field 'isAnonymous' has the following description: True means that the entityCode is synthetic, and doesn't actually exist in the namespace. isAnonymous is used for synthetic top and bottom nodes as well as blank or anonymous inner class definitions. Default: False

Returns:
the value of field 'IsAnonymous'.

isIsDefined

public java.lang.Boolean isIsDefined()
Returns the value of field 'isDefined'. The field 'isDefined' has the following description: True means that this entityCode is considered to be completely defined (i.e. necessary and sufficient) within the context of the containing code system. False means that only the necessary components are present. If omitted, the state of the entityCode definition is not known.

Returns:
the value of field 'IsDefined'.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class VersionableAndDescribable
Returns:
true if this object is valid according to the schema

iterateComment

public java.util.Iterator<Comment> iterateComment()
Method iterateComment.

Returns:
an Iterator over all possible elements in this collection

iterateDefinition

public java.util.Iterator<Definition> iterateDefinition()
Method iterateDefinition.

Returns:
an Iterator over all possible elements in this collection

iterateEntityType

public java.util.Iterator<java.lang.String> iterateEntityType()
Method iterateEntityType.

Returns:
an Iterator over all possible elements in this collection

iteratePresentation

public java.util.Iterator<Presentation> iteratePresentation()
Method iteratePresentation.

Returns:
an Iterator over all possible elements in this collection

iterateProperty

public java.util.Iterator<Property> iterateProperty()
Method iterateProperty.

Returns:
an Iterator over all possible elements in this collection

iteratePropertyLink

public java.util.Iterator<PropertyLink> iteratePropertyLink()
Method iteratePropertyLink.

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
Overrides:
marshal in class VersionableAndDescribable
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
Overrides:
marshal in class VersionableAndDescribable
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

removeAllComment

public void removeAllComment()

removeAllDefinition

public void removeAllDefinition()

removeAllEntityType

public void removeAllEntityType()

removeAllPresentation

public void removeAllPresentation()

removeAllProperty

public void removeAllProperty()

removeAllPropertyLink

public void removeAllPropertyLink()

removeComment

public boolean removeComment(Comment vComment)
Method removeComment.

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

removeCommentAt

public Comment removeCommentAt(int index)
Method removeCommentAt.

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

removeDefinition

public boolean removeDefinition(Definition vDefinition)
Method removeDefinition.

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

removeDefinitionAt

public Definition removeDefinitionAt(int index)
Method removeDefinitionAt.

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

removeEntityType

public boolean removeEntityType(java.lang.String vEntityType)
Method removeEntityType.

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

removeEntityTypeAt

public java.lang.String removeEntityTypeAt(int index)
Method removeEntityTypeAt.

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

removePresentation

public boolean removePresentation(Presentation vPresentation)
Method removePresentation.

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

removePresentationAt

public Presentation removePresentationAt(int index)
Method removePresentationAt.

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

removeProperty

public boolean removeProperty(Property vProperty)
Method removeProperty.

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

removePropertyAt

public Property removePropertyAt(int index)
Method removePropertyAt.

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

removePropertyLink

public boolean removePropertyLink(PropertyLink vPropertyLink)
Method removePropertyLink.

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

removePropertyLinkAt

public PropertyLink removePropertyLinkAt(int index)
Method removePropertyLinkAt.

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

setComment

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

setComment

public void setComment(Comment[] vCommentArray)
Parameters:
vCommentArray -

setDefinition

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

setDefinition

public void setDefinition(Definition[] vDefinitionArray)
Parameters:
vDefinitionArray -

setEntityCode

public void setEntityCode(java.lang.String entityCode)
Sets the value of field 'entityCode'. The field 'entityCode' has the following description: The entity code being defined.

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

setEntityCodeNamespace

public void setEntityCodeNamespace(java.lang.String entityCodeNamespace)
Sets the value of field 'entityCodeNamespace'. The field 'entityCodeNamespace' has the following description: Local identifier of the namespace of the entityCode. entityCodeNamespace must match a local id of a supportedNamespace in the corresponding mappings section. If omitted, the URI of the defaultCodingScheme will be used as the namespace for the entity code.

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

setEntityType

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

setEntityType

public void setEntityType(java.lang.String[] vEntityTypeArray)
Parameters:
vEntityTypeArray -

setIsAnonymous

public void setIsAnonymous(java.lang.Boolean isAnonymous)
Sets the value of field 'isAnonymous'. The field 'isAnonymous' has the following description: True means that the entityCode is synthetic, and doesn't actually exist in the namespace. isAnonymous is used for synthetic top and bottom nodes as well as blank or anonymous inner class definitions. Default: False

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

setIsDefined

public void setIsDefined(java.lang.Boolean isDefined)
Sets the value of field 'isDefined'. The field 'isDefined' has the following description: True means that this entityCode is considered to be completely defined (i.e. necessary and sufficient) within the context of the containing code system. False means that only the necessary components are present. If omitted, the state of the entityCode definition is not known.

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

setPresentation

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

setPresentation

public void setPresentation(Presentation[] vPresentationArray)
Parameters:
vPresentationArray -

setProperty

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

setProperty

public void setProperty(Property[] vPropertyArray)
Parameters:
vPropertyArray -

setPropertyLink

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

setPropertyLink

public void setPropertyLink(PropertyLink[] vPropertyLinkArray)
Parameters:
vPropertyLinkArray -

unmarshalEntity

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.concepts.Entity
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
Overrides:
validate in class VersionableAndDescribable
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

getAllProperties

public Property[] getAllProperties()
Returns all of the Properties (and subclasses of Property) contained by this Entity.

Returns:
All of the Properties of this Entity.

addAnyProperties

public void addAnyProperties(java.util.List<Property> properties)
Adds all of the Properties (or subclasses of Property) in a given List to this Entity. Used for batch-type Property insertion. Subclasses of Property are accepted and directed to the correct Collection.

Parameters:
property - The List of Properties to be added (List may contain subclass of Property).

addAnyProperty

public void addAnyProperty(Property property)
Adds any Property to this Entity. Subclasses of Property are accepted and directed to the correct Collection.

Parameters:
property - The Property to be added (may be a subclass of Property).

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.