org.LexGrid.commonTypes
Class Describable

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.commonTypes.Describable
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
EntityVersion, Relation, Revision, Revision, SystemRelease, SystemRelease, SystemReleaseDirectoryEntry

public class Describable
extends LexGridBase
implements java.io.Serializable

Any resource that can have an associated description.

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

Constructor Summary
Describable()
           
 
Method Summary
 EntityDescription getEntityDescription()
          Returns the value of field 'entityDescription'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setEntityDescription(EntityDescription entityDescription)
          Sets the value of field 'entityDescription'.
static Describable unmarshalDescribable(java.io.Reader reader)
          Method unmarshalDescribable.
 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

Describable

public Describable()
Method Detail

getEntityDescription

public EntityDescription getEntityDescription()
Returns the value of field 'entityDescription'. The field 'entityDescription' has the following description: The description of the resource.

Returns:
the value of field 'EntityDescription'.

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

setEntityDescription

public void setEntityDescription(EntityDescription entityDescription)
Sets the value of field 'entityDescription'. The field 'entityDescription' has the following description: The description of the resource.

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

unmarshalDescribable

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

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