|
|||||||||
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.commonTypes.VersionableAndDescribable
org.LexGrid.REST.concepts.Entity
public class Entity
A set of lexical assertions about the intended meaning of a particular entity code.
Constructor Summary | |
---|---|
Entity()
|
Method Summary | |
---|---|
void |
addComment(Comment vComment)
|
void |
addComment(int index,
Comment vComment)
|
void |
addDefinition(Definition vDefinition)
|
void |
addDefinition(int index,
Definition vDefinition)
|
void |
addEntityType(EntityType vEntityType)
|
void |
addEntityType(int index,
EntityType vEntityType)
|
void |
addPresentation(int index,
Presentation vPresentation)
|
void |
addPresentation(Presentation vPresentation)
|
java.util.Enumeration<? extends Comment> |
enumerateComment()
Method enumerateComment. |
java.util.Enumeration<? extends Definition> |
enumerateDefinition()
Method enumerateDefinition. |
java.util.Enumeration<? extends EntityType> |
enumerateEntityType()
Method enumerateEntityType. |
java.util.Enumeration<? extends Presentation> |
enumeratePresentation()
Method enumeratePresentation. |
Comment[] |
getComment()
Method getComment.Returns the contents of the collection in an Array. |
Comment |
getComment(int index)
Method getComment. |
java.util.List<Comment> |
getCommentAsReference()
Method getCommentAsReference.Returns a reference to '_commentList'. |
int |
getCommentCount()
Method getCommentCount. |
Definition[] |
getDefinition()
Method getDefinition.Returns the contents of the collection in an Array. |
Definition |
getDefinition(int index)
Method getDefinition. |
java.util.List<Definition> |
getDefinitionAsReference()
Method getDefinitionAsReference.Returns a reference to '_definitionList'. |
int |
getDefinitionCount()
Method getDefinitionCount. |
EntityInContext |
getEntityInContext()
Returns the value of field 'entityInContext'. |
EntityType[] |
getEntityType()
Method getEntityType.Returns the contents of the collection in an Array. |
EntityType |
getEntityType(int index)
Method getEntityType. |
java.util.List<EntityType> |
getEntityTypeAsReference()
Method getEntityTypeAsReference.Returns a reference to '_entityTypeList'. |
int |
getEntityTypeCount()
Method getEntityTypeCount. |
java.lang.Boolean |
getIsAnonymous()
Returns the value of field 'isAnonymous'. |
java.lang.Boolean |
getIsDefined()
Returns the value of field 'isDefined'. |
AssociationEntrySetLink |
getObjectOf()
Returns the value of field 'objectOf'. |
AssociationEntrySetLink |
getPredicateOf()
Returns the value of field 'predicateOf'. |
Presentation[] |
getPresentation()
Method getPresentation.Returns the contents of the collection in an Array. |
Presentation |
getPresentation(int index)
Method getPresentation. |
java.util.List<Presentation> |
getPresentationAsReference()
Method getPresentationAsReference.Returns a reference to '_presentationList'. |
int |
getPresentationCount()
Method getPresentationCount. |
PropertiesLink |
getProperties()
Returns the value of field 'properties'. |
AssociationEntrySetLink |
getSubjectOf()
Returns the value of field 'subjectOf'. |
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<? extends Comment> |
iterateComment()
Method iterateComment. |
java.util.Iterator<? extends Definition> |
iterateDefinition()
Method iterateDefinition. |
java.util.Iterator<? extends EntityType> |
iterateEntityType()
Method iterateEntityType. |
java.util.Iterator<? extends Presentation> |
iteratePresentation()
Method iteratePresentation. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllComment()
|
void |
removeAllDefinition()
|
void |
removeAllEntityType()
|
void |
removeAllPresentation()
|
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(EntityType vEntityType)
Method removeEntityType. |
EntityType |
removeEntityTypeAt(int index)
Method removeEntityTypeAt. |
boolean |
removePresentation(Presentation vPresentation)
Method removePresentation. |
Presentation |
removePresentationAt(int index)
Method removePresentationAt. |
void |
setComment(Comment[] vCommentArray)
|
void |
setComment(int index,
Comment vComment)
|
void |
setComment(java.util.List<Comment> vCommentList)
Sets the value of '_commentList' by copying the given Vector. |
void |
setCommentAsReference(java.util.List<Comment> commentList)
Deprecated. |
void |
setDefinition(Definition[] vDefinitionArray)
|
void |
setDefinition(int index,
Definition vDefinition)
|
void |
setDefinition(java.util.List<Definition> vDefinitionList)
Sets the value of '_definitionList' by copying the given Vector. |
void |
setDefinitionAsReference(java.util.List<Definition> definitionList)
Deprecated. |
void |
setEntityInContext(EntityInContext entityInContext)
Sets the value of field 'entityInContext'. |
void |
setEntityType(EntityType[] vEntityTypeArray)
|
void |
setEntityType(int index,
EntityType vEntityType)
|
void |
setEntityType(java.util.List<EntityType> vEntityTypeList)
Sets the value of '_entityTypeList' by copying the given Vector. |
void |
setEntityTypeAsReference(java.util.List<EntityType> entityTypeList)
Deprecated. |
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 |
setObjectOf(AssociationEntrySetLink objectOf)
Sets the value of field 'objectOf'. |
void |
setPredicateOf(AssociationEntrySetLink predicateOf)
Sets the value of field 'predicateOf'. |
void |
setPresentation(int index,
Presentation vPresentation)
|
void |
setPresentation(java.util.List<Presentation> vPresentationList)
Sets the value of '_presentationList' by copying the given Vector. |
void |
setPresentation(Presentation[] vPresentationArray)
|
void |
setPresentationAsReference(java.util.List<Presentation> presentationList)
Deprecated. |
void |
setProperties(PropertiesLink properties)
Sets the value of field 'properties'. |
void |
setSubjectOf(AssociationEntrySetLink subjectOf)
Sets the value of field 'subjectOf'. |
static Entity |
unmarshalEntity(java.io.Reader reader)
Method unmarshalEntity. |
void |
validate()
|
Methods inherited from class org.LexGrid.REST.commonTypes.VersionableAndDescribable |
---|
getEntityDescription, setEntityDescription, unmarshalVersionableAndDescribable |
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 Entity()
Method Detail |
---|
public void addComment(Comment vComment) throws java.lang.IndexOutOfBoundsException
vComment
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addComment(int index, Comment vComment) throws java.lang.IndexOutOfBoundsException
index
- vComment
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefinition(Definition vDefinition) throws java.lang.IndexOutOfBoundsException
vDefinition
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addDefinition(int index, Definition vDefinition) throws java.lang.IndexOutOfBoundsException
index
- vDefinition
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addEntityType(EntityType vEntityType) throws java.lang.IndexOutOfBoundsException
vEntityType
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addEntityType(int index, EntityType vEntityType) throws java.lang.IndexOutOfBoundsException
index
- vEntityType
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPresentation(Presentation vPresentation) throws java.lang.IndexOutOfBoundsException
vPresentation
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addPresentation(int index, Presentation vPresentation) throws java.lang.IndexOutOfBoundsException
index
- vPresentation
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends Comment> enumerateComment()
public java.util.Enumeration<? extends Definition> enumerateDefinition()
public java.util.Enumeration<? extends EntityType> enumerateEntityType()
public java.util.Enumeration<? extends Presentation> enumeratePresentation()
public Comment getComment(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Comment[] getComment()
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<Comment> getCommentAsReference()
public int getCommentCount()
public Definition getDefinition(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Definition[] getDefinition()
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<Definition> getDefinitionAsReference()
public int getDefinitionCount()
public EntityInContext getEntityInContext()
public EntityType getEntityType(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic EntityType[] getEntityType()
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<EntityType> getEntityTypeAsReference()
public int getEntityTypeCount()
public java.lang.Boolean getIsAnonymous()
public java.lang.Boolean getIsDefined()
public AssociationEntrySetLink getObjectOf()
public AssociationEntrySetLink getPredicateOf()
public Presentation getPresentation(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Presentation[] getPresentation()
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<Presentation> getPresentationAsReference()
public int getPresentationCount()
public PropertiesLink getProperties()
public AssociationEntrySetLink getSubjectOf()
public java.lang.Boolean isIsAnonymous()
public java.lang.Boolean isIsDefined()
public boolean isValid()
isValid
in class VersionableAndDescribable
public java.util.Iterator<? extends Comment> iterateComment()
public java.util.Iterator<? extends Definition> iterateDefinition()
public java.util.Iterator<? extends EntityType> iterateEntityType()
public java.util.Iterator<? extends Presentation> iteratePresentation()
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 removeAllComment()
public void removeAllDefinition()
public void removeAllEntityType()
public void removeAllPresentation()
public boolean removeComment(Comment vComment)
vComment
-
public Comment removeCommentAt(int index)
index
-
public boolean removeDefinition(Definition vDefinition)
vDefinition
-
public Definition removeDefinitionAt(int index)
index
-
public boolean removeEntityType(EntityType vEntityType)
vEntityType
-
public EntityType removeEntityTypeAt(int index)
index
-
public boolean removePresentation(Presentation vPresentation)
vPresentation
-
public Presentation removePresentationAt(int index)
index
-
public void setComment(int index, Comment vComment) throws java.lang.IndexOutOfBoundsException
index
- vComment
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setComment(Comment[] vCommentArray)
vCommentArray
- public void setComment(java.util.List<Comment> vCommentList)
vCommentList
- the Vector to copy.public void setCommentAsReference(java.util.List<Comment> commentList)
commentList
- the Vector to set.public void setDefinition(int index, Definition vDefinition) throws java.lang.IndexOutOfBoundsException
index
- vDefinition
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setDefinition(Definition[] vDefinitionArray)
vDefinitionArray
- public void setDefinition(java.util.List<Definition> vDefinitionList)
vDefinitionList
- the Vector to copy.public void setDefinitionAsReference(java.util.List<Definition> definitionList)
definitionList
- the Vector to set.public void setEntityInContext(EntityInContext entityInContext)
entityInContext
- the value of field 'entityInContext'.public void setEntityType(int index, EntityType vEntityType) throws java.lang.IndexOutOfBoundsException
index
- vEntityType
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setEntityType(EntityType[] vEntityTypeArray)
vEntityTypeArray
- public void setEntityType(java.util.List<EntityType> vEntityTypeList)
vEntityTypeList
- the Vector to copy.public void setEntityTypeAsReference(java.util.List<EntityType> entityTypeList)
entityTypeList
- the Vector to set.public void setIsAnonymous(java.lang.Boolean isAnonymous)
isAnonymous
- the value of field 'isAnonymous'.public void setIsDefined(java.lang.Boolean isDefined)
isDefined
- the value of field 'isDefined'.public void setObjectOf(AssociationEntrySetLink objectOf)
objectOf
- the value of field 'objectOf'.public void setPredicateOf(AssociationEntrySetLink predicateOf)
predicateOf
- the value of field 'predicateOf'.public void setPresentation(int index, Presentation vPresentation) throws java.lang.IndexOutOfBoundsException
index
- vPresentation
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setPresentation(Presentation[] vPresentationArray)
vPresentationArray
- public void setPresentation(java.util.List<Presentation> vPresentationList)
vPresentationList
- the Vector to copy.public void setPresentationAsReference(java.util.List<Presentation> presentationList)
presentationList
- the Vector to set.public void setProperties(PropertiesLink properties)
properties
- the value of field 'properties'.public void setSubjectOf(AssociationEntrySetLink subjectOf)
subjectOf
- the value of field 'subjectOf'.public static Entity unmarshalEntity(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 |