org.LexGrid.relations
Class AssociationEntity

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.commonTypes.Versionable
          extended by org.LexGrid.commonTypes.VersionableAndDescribable
              extended by org.LexGrid.concepts.Entity
                  extended by org.LexGrid.relations.AssociationEntity
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
IdableAssociationEntity, LazyLoadableEntity

public class AssociationEntity
extends Entity
implements java.io.Serializable

A binary relation from a set of entities to a set of entities and/or data. The entityType for the class concept must be "association".

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

Constructor Summary
AssociationEntity()
           
 
Method Summary
 java.lang.String getForwardName()
          Returns the value of field 'forwardName'.
 java.lang.Boolean getIsNavigable()
          Returns the value of field 'isNavigable'.
 java.lang.Boolean getIsTransitive()
          Returns the value of field 'isTransitive'.
 java.lang.String getReverseName()
          Returns the value of field 'reverseName'.
 java.lang.Boolean isIsNavigable()
          Returns the value of field 'isNavigable'.
 java.lang.Boolean isIsTransitive()
          Returns the value of field 'isTransitive'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setForwardName(java.lang.String forwardName)
          Sets the value of field 'forwardName'.
 void setIsNavigable(java.lang.Boolean isNavigable)
          Sets the value of field 'isNavigable'.
 void setIsTransitive(java.lang.Boolean isTransitive)
          Sets the value of field 'isTransitive'.
 void setReverseName(java.lang.String reverseName)
          Sets the value of field 'reverseName'.
static AssociationEntity unmarshalAssociationEntity(java.io.Reader reader)
          Method unmarshalAssociationEntity.
 void validate()
           
 
Methods inherited from class org.LexGrid.concepts.Entity
addAnyProperties, addAnyProperty, addComment, addComment, addDefinition, addDefinition, addEntityType, addEntityType, addPresentation, addPresentation, addProperty, addProperty, addPropertyLink, addPropertyLink, enumerateComment, enumerateDefinition, enumerateEntityType, enumeratePresentation, enumerateProperty, enumeratePropertyLink, getAllProperties, getComment, getComment, getCommentAsReference, getCommentCount, getDefinition, getDefinition, getDefinitionAsReference, getDefinitionCount, getEntityCode, getEntityCodeNamespace, getEntityType, getEntityType, getEntityTypeAsReference, getEntityTypeCount, getIsAnonymous, getIsDefined, getPresentation, getPresentation, getPresentationAsReference, getPresentationCount, getProperty, getProperty, getPropertyAsReference, getPropertyCount, getPropertyLink, getPropertyLink, getPropertyLinkAsReference, getPropertyLinkCount, isIsAnonymous, isIsDefined, iterateComment, iterateDefinition, iterateEntityType, iteratePresentation, iterateProperty, iteratePropertyLink, removeAllComment, removeAllDefinition, removeAllEntityType, removeAllPresentation, removeAllProperty, removeAllPropertyLink, removeComment, removeCommentAt, removeDefinition, removeDefinitionAt, removeEntityType, removeEntityTypeAt, removePresentation, removePresentationAt, removeProperty, removePropertyAt, removePropertyLink, removePropertyLinkAt, setComment, setComment, setComment, setCommentAsReference, setDefinition, setDefinition, setDefinition, setDefinitionAsReference, setEntityCode, setEntityCodeNamespace, setEntityType, setEntityType, setEntityType, setEntityTypeAsReference, setIsAnonymous, setIsDefined, setPresentation, setPresentation, setPresentation, setPresentationAsReference, setProperty, setProperty, setProperty, setPropertyAsReference, setPropertyLink, setPropertyLink, setPropertyLink, setPropertyLinkAsReference, unmarshalEntity
 
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 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

AssociationEntity

public AssociationEntity()
Method Detail

getForwardName

public java.lang.String getForwardName()
Returns the value of field 'forwardName'. The field 'forwardName' has the following description: The name or role that the "from" entity plays with respect to the "to" entry. Should be phrased in terms of the default language of the association and imply direction.

Returns:
the value of field 'ForwardName'.

getIsNavigable

public java.lang.Boolean getIsNavigable()
Returns the value of field 'isNavigable'. The field 'isNavigable' has the following description: True means that the reverse direction of the association is "navigable", meaning that it is makes sense to represent the target to source side of the association.

Returns:
the value of field 'IsNavigable'.

getIsTransitive

public java.lang.Boolean getIsTransitive()
Returns the value of field 'isTransitive'. The field 'isTransitive' has the following description: True means that association is transitive ( r(a,b), r(b,c) -> r(a,c)). False means not transitive. If absent, transitivity is unknown or not applicable.

Returns:
the value of field 'IsTransitive'.

getReverseName

public java.lang.String getReverseName()
Returns the value of field 'reverseName'. The field 'reverseName' has the following description: The name or role that the "to" entity plays with respect to the "from" entry. Should be phrased in terms of the default language of the association and imply direction.

Returns:
the value of field 'ReverseName'.

isIsNavigable

public java.lang.Boolean isIsNavigable()
Returns the value of field 'isNavigable'. The field 'isNavigable' has the following description: True means that the reverse direction of the association is "navigable", meaning that it is makes sense to represent the target to source side of the association.

Returns:
the value of field 'IsNavigable'.

isIsTransitive

public java.lang.Boolean isIsTransitive()
Returns the value of field 'isTransitive'. The field 'isTransitive' has the following description: True means that association is transitive ( r(a,b), r(b,c) -> r(a,c)). False means not transitive. If absent, transitivity is unknown or not applicable.

Returns:
the value of field 'IsTransitive'.

isValid

public boolean isValid()
Method isValid.

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

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Overrides:
marshal in class Entity
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 Entity
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

setForwardName

public void setForwardName(java.lang.String forwardName)
Sets the value of field 'forwardName'. The field 'forwardName' has the following description: The name or role that the "from" entity plays with respect to the "to" entry. Should be phrased in terms of the default language of the association and imply direction.

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

setIsNavigable

public void setIsNavigable(java.lang.Boolean isNavigable)
Sets the value of field 'isNavigable'. The field 'isNavigable' has the following description: True means that the reverse direction of the association is "navigable", meaning that it is makes sense to represent the target to source side of the association.

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

setIsTransitive

public void setIsTransitive(java.lang.Boolean isTransitive)
Sets the value of field 'isTransitive'. The field 'isTransitive' has the following description: True means that association is transitive ( r(a,b), r(b,c) -> r(a,c)). False means not transitive. If absent, transitivity is unknown or not applicable.

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

setReverseName

public void setReverseName(java.lang.String reverseName)
Sets the value of field 'reverseName'. The field 'reverseName' has the following description: The name or role that the "to" entity plays with respect to the "from" entry. Should be phrased in terms of the default language of the association and imply direction.

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

unmarshalAssociationEntity

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.relations.AssociationEntity
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 Entity
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.