org.LexGrid.REST.concepts
Class EntityInContext

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.concepts.EntityInContext
All Implemented Interfaces:
java.io.Serializable

public class EntityInContext
extends LexGridBase
implements java.io.Serializable

A reference to a specific entity within the context of a code system

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

Constructor Summary
EntityInContext()
           
 
Method Summary
 EntityCode getEntityCode()
          Returns the value of field 'entityCode'.
 NamespaceName getEntityCodeNamespace()
          Returns the value of field 'entityCodeNamespace'.
 CodingSchemeName getReferenceCodingScheme()
          Returns the value of field 'referenceCodingScheme'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setEntityCode(EntityCode entityCode)
          Sets the value of field 'entityCode'.
 void setEntityCodeNamespace(NamespaceName entityCodeNamespace)
          Sets the value of field 'entityCodeNamespace'.
 void setReferenceCodingScheme(CodingSchemeName referenceCodingScheme)
          Sets the value of field 'referenceCodingScheme'.
static EntityInContext unmarshalEntityInContext(java.io.Reader reader)
          Method unmarshalEntityInContext.
 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

EntityInContext

public EntityInContext()
Method Detail

getEntityCode

public EntityCode getEntityCode()
Returns the value of field 'entityCode'. The field 'entityCode' has the following description: The entity code and URL of the entity within the containing coding scheme

Returns:
the value of field 'EntityCode'.

getEntityCodeNamespace

public NamespaceName getEntityCodeNamespace()
Returns the value of field 'entityCodeNamespace'. The field 'entityCodeNamespace' has the following description: The local namespace name and URL of the entity code namespace

Returns:
the value of field 'EntityCodeNamespace'.

getReferenceCodingScheme

public CodingSchemeName getReferenceCodingScheme()
Returns the value of field 'referenceCodingScheme'. The field 'referenceCodingScheme' has the following description: The local name and URL of the contiaining coding scheme

Returns:
the value of field 'ReferenceCodingScheme'.

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(EntityCode entityCode)
Sets the value of field 'entityCode'. The field 'entityCode' has the following description: The entity code and URL of the entity within the containing coding scheme

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

setEntityCodeNamespace

public void setEntityCodeNamespace(NamespaceName entityCodeNamespace)
Sets the value of field 'entityCodeNamespace'. The field 'entityCodeNamespace' has the following description: The local namespace name and URL of the entity code namespace

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

setReferenceCodingScheme

public void setReferenceCodingScheme(CodingSchemeName referenceCodingScheme)
Sets the value of field 'referenceCodingScheme'. The field 'referenceCodingScheme' has the following description: The local name and URL of the contiaining coding scheme

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

unmarshalEntityInContext

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.concepts.EntityInContext
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.