org.LexGrid.valueSets
Class DefinitionEntry

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

public class DefinitionEntry
extends Versionable
implements java.io.Serializable

A reference to an entry code, a coding scheme or another value set definition along with the instructions about how the reference is applied. Definition entrys are applied in entryOrder, with each successive entry either adding to or subtracting from the final set of entity codes.

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

Constructor Summary
DefinitionEntry()
           
 
Method Summary
 java.lang.Object getChoiceValue()
          Returns the value of field 'choiceValue'.
 CodingSchemeReference getCodingSchemeReference()
          Returns the value of field 'codingSchemeReference'.
 EntityReference getEntityReference()
          Returns the value of field 'entityReference'.
 DefinitionOperator getOperator()
          Returns the value of field 'operator'.
 PropertyReference getPropertyReference()
          Returns the value of field 'propertyReference'.
 java.lang.Long getRuleOrder()
          Returns the value of field 'ruleOrder'.
 ValueSetDefinitionReference getValueSetDefinitionReference()
          Returns the value of field 'valueSetDefinitionReference'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setCodingSchemeReference(CodingSchemeReference codingSchemeReference)
          Sets the value of field 'codingSchemeReference'.
 void setEntityReference(EntityReference entityReference)
          Sets the value of field 'entityReference'.
 void setOperator(DefinitionOperator operator)
          Sets the value of field 'operator'.
 void setPropertyReference(PropertyReference propertyReference)
          Sets the value of field 'propertyReference'.
 void setRuleOrder(java.lang.Long ruleOrder)
          Sets the value of field 'ruleOrder'.
 void setValueSetDefinitionReference(ValueSetDefinitionReference valueSetDefinitionReference)
          Sets the value of field 'valueSetDefinitionReference'.
static DefinitionEntry unmarshalDefinitionEntry(java.io.Reader reader)
          Method unmarshalDefinitionEntry.
 void validate()
           
 
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

DefinitionEntry

public DefinitionEntry()
Method Detail

getChoiceValue

public java.lang.Object getChoiceValue()
Returns the value of field 'choiceValue'. The field 'choiceValue' has the following description: Internal choice value storage

Returns:
the value of field 'ChoiceValue'.

getCodingSchemeReference

public CodingSchemeReference getCodingSchemeReference()
Returns the value of field 'codingSchemeReference'.

Returns:
the value of field 'CodingSchemeReference'.

getEntityReference

public EntityReference getEntityReference()
Returns the value of field 'entityReference'.

Returns:
the value of field 'EntityReference'.

getOperator

public DefinitionOperator getOperator()
Returns the value of field 'operator'. The field 'operator' has the following description: How this entry is to be applied to the value set definition

Returns:
the value of field 'Operator'.

getPropertyReference

public PropertyReference getPropertyReference()
Returns the value of field 'propertyReference'.

Returns:
the value of field 'PropertyReference'.

getRuleOrder

public java.lang.Long getRuleOrder()
Returns the value of field 'ruleOrder'. The field 'ruleOrder' has the following description: The unique identifier of the definition entry within the definition as well as the relative order in which this entry should be applied

Returns:
the value of field 'RuleOrder'.

getValueSetDefinitionReference

public ValueSetDefinitionReference getValueSetDefinitionReference()
Returns the value of field 'valueSetDefinitionReference'.

Returns:
the value of field 'ValueSetDefinitionReference'.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class Versionable
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 Versionable
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 Versionable
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

setCodingSchemeReference

public void setCodingSchemeReference(CodingSchemeReference codingSchemeReference)
Sets the value of field 'codingSchemeReference'.

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

setEntityReference

public void setEntityReference(EntityReference entityReference)
Sets the value of field 'entityReference'.

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

setOperator

public void setOperator(DefinitionOperator operator)
Sets the value of field 'operator'. The field 'operator' has the following description: How this entry is to be applied to the value set definition

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

setPropertyReference

public void setPropertyReference(PropertyReference propertyReference)
Sets the value of field 'propertyReference'.

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

setRuleOrder

public void setRuleOrder(java.lang.Long ruleOrder)
Sets the value of field 'ruleOrder'. The field 'ruleOrder' has the following description: The unique identifier of the definition entry within the definition as well as the relative order in which this entry should be applied

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

setValueSetDefinitionReference

public void setValueSetDefinitionReference(ValueSetDefinitionReference valueSetDefinitionReference)
Sets the value of field 'valueSetDefinitionReference'.

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

unmarshalDefinitionEntry

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

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