org.LexGrid.LexOnt
Class CsmfEntityDescription

java.lang.Object
  extended by org.LexGrid.builtins.TsAnyType
      extended by org.LexGrid.commonTypes.EntityDescription
          extended by org.LexGrid.LexOnt.CsmfEntityDescription
All Implemented Interfaces:
java.io.Serializable

public class CsmfEntityDescription
extends EntityDescription
implements java.io.Serializable

Based on lgCommon:entityDescription.

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

Constructor Summary
CsmfEntityDescription()
           
 
Method Summary
 java.lang.Boolean getToOverride()
          Returns the value of field 'toOverride'.
 java.lang.Boolean isToOverride()
          Returns the value of field 'toOverride'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setToOverride(java.lang.Boolean toOverride)
          Sets the value of field 'toOverride'.
static CsmfEntityDescription unmarshalCsmfEntityDescription(java.io.Reader reader)
          Method unmarshalCsmfEntityDescription.
 void validate()
           
 
Methods inherited from class org.LexGrid.commonTypes.EntityDescription
getContent, setContent, unmarshalEntityDescription
 
Methods inherited from class org.LexGrid.builtins.TsAnyType
addAnyObject, addAnyObject, enumerateAnyObject, getAnyObject, getAnyObject, getAnyObjectCount, iterateAnyObject, removeAllAnyObject, removeAnyObject, removeAnyObjectAt, setAnyObject, setAnyObject, unmarshalTsAnyType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CsmfEntityDescription

public CsmfEntityDescription()
Method Detail

getToOverride

public java.lang.Boolean getToOverride()
Returns the value of field 'toOverride'. The field 'toOverride' has the following description: If this flag is 'true', the value provided in the source file will be replaced with this one. Otherwise, this value is treated as a default value and used only if the value is not provided in the source file. The default value of this is set to 'true'.

Returns:
the value of field 'ToOverride'.

isToOverride

public java.lang.Boolean isToOverride()
Returns the value of field 'toOverride'. The field 'toOverride' has the following description: If this flag is 'true', the value provided in the source file will be replaced with this one. Otherwise, this value is treated as a default value and used only if the value is not provided in the source file. The default value of this is set to 'true'.

Returns:
the value of field 'ToOverride'.

isValid

public boolean isValid()
Method isValid.

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

setToOverride

public void setToOverride(java.lang.Boolean toOverride)
Sets the value of field 'toOverride'. The field 'toOverride' has the following description: If this flag is 'true', the value provided in the source file will be replaced with this one. Otherwise, this value is treated as a default value and used only if the value is not provided in the source file. The default value of this is set to 'true'.

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

unmarshalCsmfEntityDescription

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.LexOnt.CsmfEntityDescription
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 EntityDescription
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.