org.LexGrid.valueSets
Class PropertyReference

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

public class PropertyReference
extends LexGridBase
implements java.io.Serializable

A reference to a propertyName or propertyValue and matchAlgoritm to use.

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

Constructor Summary
PropertyReference()
           
 
Method Summary
 java.lang.String getCodingScheme()
          Returns the value of field 'codingScheme'.
 PropertyMatchValue getPropertyMatchValue()
          Returns the value of field 'propertyMatchValue'.
 java.lang.String getPropertyName()
          Returns the value of field 'propertyName'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setCodingScheme(java.lang.String codingScheme)
          Sets the value of field 'codingScheme'.
 void setPropertyMatchValue(PropertyMatchValue propertyMatchValue)
          Sets the value of field 'propertyMatchValue'.
 void setPropertyName(java.lang.String propertyName)
          Sets the value of field 'propertyName'.
static PropertyReference unmarshalPropertyReference(java.io.Reader reader)
          Method unmarshalPropertyReference.
 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

PropertyReference

public PropertyReference()
Method Detail

getCodingScheme

public java.lang.String getCodingScheme()
Returns the value of field 'codingScheme'. The field 'codingScheme' has the following description: The local identifier of the codingScheme that this propertyreference will be resolved against. codingScheme must match a local id of a supportedCodingscheme in the corresponding mappings section.

Returns:
the value of field 'CodingScheme'.

getPropertyMatchValue

public PropertyMatchValue getPropertyMatchValue()
Returns the value of field 'propertyMatchValue'. The field 'propertyMatchValue' has the following description: Value to be used to restrict entity property. matchAlgorithm can be used in conjunction to get matching entity properties.

Returns:
the value of field 'PropertyMatchValue'.

getPropertyName

public java.lang.String getPropertyName()
Returns the value of field 'propertyName'. The field 'propertyName' has the following description: The local identifier to be used to restrict the entities to have property with this name. Must match a local id of a supportedProperty in the corresponding mappings section.

Returns:
the value of field 'PropertyName'.

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

setCodingScheme

public void setCodingScheme(java.lang.String codingScheme)
Sets the value of field 'codingScheme'. The field 'codingScheme' has the following description: The local identifier of the codingScheme that this propertyreference will be resolved against. codingScheme must match a local id of a supportedCodingscheme in the corresponding mappings section.

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

setPropertyMatchValue

public void setPropertyMatchValue(PropertyMatchValue propertyMatchValue)
Sets the value of field 'propertyMatchValue'. The field 'propertyMatchValue' has the following description: Value to be used to restrict entity property. matchAlgorithm can be used in conjunction to get matching entity properties.

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

setPropertyName

public void setPropertyName(java.lang.String propertyName)
Sets the value of field 'propertyName'. The field 'propertyName' has the following description: The local identifier to be used to restrict the entities to have property with this name. Must match a local id of a supportedProperty in the corresponding mappings section.

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

unmarshalPropertyReference

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

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