org.LexGrid.REST.concepts
Class Presentations

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

public class Presentations
extends LexGridBase
implements java.io.Serializable

Used to select all of the presentations from an entity. The URL is actually not linkable directly

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

Constructor Summary
Presentations()
           
 
Method Summary
 void addPresentation(int index, Presentation vPresentation)
           
 void addPresentation(Presentation vPresentation)
           
 java.util.Enumeration<? extends Presentation> enumeratePresentation()
          Method enumeratePresentation.
 Presentation[] getPresentation()
          Method getPresentation.Returns the contents of the collection in an Array.
 Presentation getPresentation(int index)
          Method getPresentation.
 java.util.List<Presentation> getPresentationAsReference()
          Method getPresentationAsReference.Returns a reference to '_presentationList'.
 int getPresentationCount()
          Method getPresentationCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends Presentation> iteratePresentation()
          Method iteratePresentation.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllPresentation()
           
 boolean removePresentation(Presentation vPresentation)
          Method removePresentation.
 Presentation removePresentationAt(int index)
          Method removePresentationAt.
 void setPresentation(int index, Presentation vPresentation)
           
 void setPresentation(java.util.List<Presentation> vPresentationList)
          Sets the value of '_presentationList' by copying the given Vector.
 void setPresentation(Presentation[] vPresentationArray)
           
 void setPresentationAsReference(java.util.List<Presentation> presentationList)
          Deprecated.  
static Presentations unmarshalPresentations(java.io.Reader reader)
          Method unmarshalPresentations.
 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

Presentations

public Presentations()
Method Detail

addPresentation

public void addPresentation(Presentation vPresentation)
                     throws java.lang.IndexOutOfBoundsException
Parameters:
vPresentation -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPresentation

public void addPresentation(int index,
                            Presentation vPresentation)
                     throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vPresentation -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumeratePresentation

public java.util.Enumeration<? extends Presentation> enumeratePresentation()
Method enumeratePresentation.

Returns:
an Enumeration over all possible elements of this collection

getPresentation

public Presentation getPresentation(int index)
                             throws java.lang.IndexOutOfBoundsException
Method getPresentation.

Parameters:
index -
Returns:
the value of the org.LexGrid.REST.concepts.Presentation at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getPresentation

public Presentation[] getPresentation()
Method getPresentation.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getPresentationAsReference

public java.util.List<Presentation> getPresentationAsReference()
Method getPresentationAsReference.Returns a reference to '_presentationList'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getPresentationCount

public int getPresentationCount()
Method getPresentationCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iteratePresentation

public java.util.Iterator<? extends Presentation> iteratePresentation()
Method iteratePresentation.

Returns:
an Iterator over all possible elements in this collection

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

removeAllPresentation

public void removeAllPresentation()

removePresentation

public boolean removePresentation(Presentation vPresentation)
Method removePresentation.

Parameters:
vPresentation -
Returns:
true if the object was removed from the collection.

removePresentationAt

public Presentation removePresentationAt(int index)
Method removePresentationAt.

Parameters:
index -
Returns:
the element removed from the collection

setPresentation

public void setPresentation(int index,
                            Presentation vPresentation)
                     throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vPresentation -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setPresentation

public void setPresentation(Presentation[] vPresentationArray)
Parameters:
vPresentationArray -

setPresentation

public void setPresentation(java.util.List<Presentation> vPresentationList)
Sets the value of '_presentationList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vPresentationList - the Vector to copy.

setPresentationAsReference

public void setPresentationAsReference(java.util.List<Presentation> presentationList)
Deprecated. 

Sets the value of '_presentationList' by setting it to the given Vector. No type checking is performed.

Parameters:
presentationList - the Vector to set.

unmarshalPresentations

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

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