org.LexGrid.commonTypes
Class Source

java.lang.Object
  extended by org.LexGrid.commonTypes.Source
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CsmfSource

public class Source
extends java.lang.Object
implements java.io.Serializable

The local identifier of a person, organization of bibliographic resource that played a role in the creation or maintenance of a resource.

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

Constructor Summary
Source()
           
Source(java.lang.String defaultValue)
           
 
Method Summary
 java.lang.String getContent()
          Returns the value of field 'content'.
 java.lang.String getRole()
          Returns the value of field 'role'.
 java.lang.String getSubRef()
          Returns the value of field 'subRef'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setContent(java.lang.String content)
          Sets the value of field 'content'.
 void setRole(java.lang.String role)
          Sets the value of field 'role'.
 void setSubRef(java.lang.String subRef)
          Sets the value of field 'subRef'.
static Source unmarshalSource(java.io.Reader reader)
          Method unmarshalSource.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Source

public Source()

Source

public Source(java.lang.String defaultValue)
Method Detail

getContent

public java.lang.String getContent()
Returns the value of field 'content'. The field 'content' has the following description: internal content storage

Returns:
the value of field 'Content'.

getRole

public java.lang.String getRole()
Returns the value of field 'role'. The field 'role' has the following description: The role or purpose of the the source for this particular resource (e.g. author, distributor). Must be absent in supportedSource

Returns:
the value of field 'Role'.

getSubRef

public java.lang.String getSubRef()
Returns the value of field 'subRef'. The field 'subRef' has the following description: The page, subheading, id or other localized information within the source itself. Used to make a source reference more precise. Must be absent in supportedSource.

Returns:
the value of field 'SubRef'.

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

setContent

public void setContent(java.lang.String content)
Sets the value of field 'content'. The field 'content' has the following description: internal content storage

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

setRole

public void setRole(java.lang.String role)
Sets the value of field 'role'. The field 'role' has the following description: The role or purpose of the the source for this particular resource (e.g. author, distributor). Must be absent in supportedSource

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

setSubRef

public void setSubRef(java.lang.String subRef)
Sets the value of field 'subRef'. The field 'subRef' has the following description: The page, subheading, id or other localized information within the source itself. Used to make a source reference more precise. Must be absent in supportedSource.

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

unmarshalSource

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

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