org.LexGrid.valueSets
Class EntityReference

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.valueSets.EntityReference
All Implemented Interfaces:
java.io.Serializable

public class EntityReference
extends LexGridBase
implements java.io.Serializable

A reference to an entityCode and/or one or more entityCodes that have a relationship to the specified entity code.

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

Constructor Summary
EntityReference()
           
 
Method Summary
 java.lang.String getEntityCode()
          Returns the value of field 'entityCode'.
 java.lang.String getEntityCodeNamespace()
          Returns the value of field 'entityCodeNamespace'.
 java.lang.Boolean getLeafOnly()
          Returns the value of field 'leafOnly'.
 java.lang.String getReferenceAssociation()
          Returns the value of field 'referenceAssociation'.
 java.lang.Boolean getTargetToSource()
          Returns the value of field 'targetToSource'.
 java.lang.Boolean getTransitiveClosure()
          Returns the value of field 'transitiveClosure'.
 java.lang.Boolean isLeafOnly()
          Returns the value of field 'leafOnly'.
 java.lang.Boolean isTargetToSource()
          Returns the value of field 'targetToSource'.
 java.lang.Boolean isTransitiveClosure()
          Returns the value of field 'transitiveClosure'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 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 setLeafOnly(java.lang.Boolean leafOnly)
          Sets the value of field 'leafOnly'.
 void setReferenceAssociation(java.lang.String referenceAssociation)
          Sets the value of field 'referenceAssociation'.
 void setTargetToSource(java.lang.Boolean targetToSource)
          Sets the value of field 'targetToSource'.
 void setTransitiveClosure(java.lang.Boolean transitiveClosure)
          Sets the value of field 'transitiveClosure'.
static EntityReference unmarshalEntityReference(java.io.Reader reader)
          Method unmarshalEntityReference.
 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

EntityReference

public EntityReference()
Method Detail

getEntityCode

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

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 URI of the entity code.

Returns:
the value of field 'EntityCodeNamespace'.

getLeafOnly

public java.lang.Boolean getLeafOnly()
Returns the value of field 'leafOnly'. The field 'leafOnly' has the following description: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that are "leaves" in transitive closure of referenceAssociation as applied to entity code. Default: false

Returns:
the value of field 'LeafOnly'.

getReferenceAssociation

public java.lang.String getReferenceAssociation()
Returns the value of field 'referenceAssociation'. The field 'referenceAssociation' has the following description: The local identifier of an association that appears in the native relations collection in the default coding scheme. This association is used to describe a set of entity codes. If absent, only the entityCode itself is included in this definition.

Returns:
the value of field 'ReferenceAssociation'.

getTargetToSource

public java.lang.Boolean getTargetToSource()
Returns the value of field 'targetToSource'. The field 'targetToSource' has the following description: If true and referenceAssociation is supplied, navigate from entityCode as the association target to the corresponding sources. If transitiveClosure is true and the referenceAssociation is transitive, include all the ancestors in the list rather than just the direct "parents" (sources).

Returns:
the value of field 'TargetToSource'.

getTransitiveClosure

public java.lang.Boolean getTransitiveClosure()
Returns the value of field 'transitiveClosure'. The field 'transitiveClosure' has the following description: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that belong to transitive closure of referenceAssociation as applied to entity code. Default: false

Returns:
the value of field 'TransitiveClosure'.

isLeafOnly

public java.lang.Boolean isLeafOnly()
Returns the value of field 'leafOnly'. The field 'leafOnly' has the following description: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that are "leaves" in transitive closure of referenceAssociation as applied to entity code. Default: false

Returns:
the value of field 'LeafOnly'.

isTargetToSource

public java.lang.Boolean isTargetToSource()
Returns the value of field 'targetToSource'. The field 'targetToSource' has the following description: If true and referenceAssociation is supplied, navigate from entityCode as the association target to the corresponding sources. If transitiveClosure is true and the referenceAssociation is transitive, include all the ancestors in the list rather than just the direct "parents" (sources).

Returns:
the value of field 'TargetToSource'.

isTransitiveClosure

public java.lang.Boolean isTransitiveClosure()
Returns the value of field 'transitiveClosure'. The field 'transitiveClosure' has the following description: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that belong to transitive closure of referenceAssociation as applied to entity code. Default: false

Returns:
the value of field 'TransitiveClosure'.

isValid

public boolean isValid()
Method isValid.

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
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

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 referenced.

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 URI of the entity code.

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

setLeafOnly

public void setLeafOnly(java.lang.Boolean leafOnly)
Sets the value of field 'leafOnly'. The field 'leafOnly' has the following description: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that are "leaves" in transitive closure of referenceAssociation as applied to entity code. Default: false

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

setReferenceAssociation

public void setReferenceAssociation(java.lang.String referenceAssociation)
Sets the value of field 'referenceAssociation'. The field 'referenceAssociation' has the following description: The local identifier of an association that appears in the native relations collection in the default coding scheme. This association is used to describe a set of entity codes. If absent, only the entityCode itself is included in this definition.

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

setTargetToSource

public void setTargetToSource(java.lang.Boolean targetToSource)
Sets the value of field 'targetToSource'. The field 'targetToSource' has the following description: If true and referenceAssociation is supplied, navigate from entityCode as the association target to the corresponding sources. If transitiveClosure is true and the referenceAssociation is transitive, include all the ancestors in the list rather than just the direct "parents" (sources).

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

setTransitiveClosure

public void setTransitiveClosure(java.lang.Boolean transitiveClosure)
Sets the value of field 'transitiveClosure'. The field 'transitiveClosure' has the following description: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that belong to transitive closure of referenceAssociation as applied to entity code. Default: false

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

unmarshalEntityReference

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.valueSets.EntityReference
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.