org.LexGrid.REST.naming
Class SupportedSource

java.lang.Object
  extended by org.mayo.edu.lgModel.LexGridBase
      extended by org.LexGrid.REST.naming.URIMap
          extended by org.LexGrid.REST.naming.SupportedSource
All Implemented Interfaces:
java.io.Serializable

public class SupportedSource
extends URIMap
implements java.io.Serializable

A source and the URI of the defining resource. Source references can also carry an additional compositional rule section that describes how to combine a subpart such as a page number, section name, etc. with the core URI in order to form a meaningful URL. An optional role can also be specified.

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

Constructor Summary
SupportedSource()
           
 
Method Summary
 java.lang.String getAssemblyRule()
          Returns the value of field 'assemblyRule'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setAssemblyRule(java.lang.String assemblyRule)
          Sets the value of field 'assemblyRule'.
static SupportedSource unmarshalSupportedSource(java.io.Reader reader)
          Method unmarshalSupportedSource.
 void validate()
           
 
Methods inherited from class org.LexGrid.REST.naming.URIMap
getLocalId, getUri, setLocalId, setUri, unmarshalURIMap
 
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

SupportedSource

public SupportedSource()
Method Detail

getAssemblyRule

public java.lang.String getAssemblyRule()
Returns the value of field 'assemblyRule'. The field 'assemblyRule' has the following description: Rule for combining source-specific information such as page numbers, sections and the like with the source URL. Syntax: [ID] - names the identifier. Everythinng else is literal.

Returns:
the value of field 'AssemblyRule'.

isValid

public boolean isValid()
Method isValid.

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

setAssemblyRule

public void setAssemblyRule(java.lang.String assemblyRule)
Sets the value of field 'assemblyRule'. The field 'assemblyRule' has the following description: Rule for combining source-specific information such as page numbers, sections and the like with the source URL. Syntax: [ID] - names the identifier. Everythinng else is literal.

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

unmarshalSupportedSource

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

Parameters:
reader -
Returns:
the unmarshaled org.LexGrid.REST.naming.SupportedSource
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 URIMap
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.