org.LexGrid.REST.versions
Class EditHistory

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

public class EditHistory
extends LexGridBase
implements java.io.Serializable

An ordered collection of revisions

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

Constructor Summary
EditHistory()
           
 
Method Summary
 void addRevision(int index, Revision vRevision)
           
 void addRevision(Revision vRevision)
           
 java.util.Enumeration<? extends Revision> enumerateRevision()
          Method enumerateRevision.
 Continuation getContinuation()
          Returns the value of field 'continuation'.
 Revision[] getRevision()
          Method getRevision.Returns the contents of the collection in an Array.
 Revision getRevision(int index)
          Method getRevision.
 java.util.List<Revision> getRevisionAsReference()
          Method getRevisionAsReference.Returns a reference to '_revisionList'.
 int getRevisionCount()
          Method getRevisionCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends Revision> iterateRevision()
          Method iterateRevision.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllRevision()
           
 boolean removeRevision(Revision vRevision)
          Method removeRevision.
 Revision removeRevisionAt(int index)
          Method removeRevisionAt.
 void setContinuation(Continuation continuation)
          Sets the value of field 'continuation'.
 void setRevision(int index, Revision vRevision)
           
 void setRevision(java.util.List<Revision> vRevisionList)
          Sets the value of '_revisionList' by copying the given Vector.
 void setRevision(Revision[] vRevisionArray)
           
 void setRevisionAsReference(java.util.List<Revision> revisionList)
          Deprecated.  
static EditHistory unmarshalEditHistory(java.io.Reader reader)
          Method unmarshalEditHistory.
 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

EditHistory

public EditHistory()
Method Detail

addRevision

public void addRevision(Revision vRevision)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vRevision -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addRevision

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

enumerateRevision

public java.util.Enumeration<? extends Revision> enumerateRevision()
Method enumerateRevision.

Returns:
an Enumeration over all possible elements of this collection

getContinuation

public Continuation getContinuation()
Returns the value of field 'continuation'.

Returns:
the value of field 'Continuation'.

getRevision

public Revision getRevision(int index)
                     throws java.lang.IndexOutOfBoundsException
Method getRevision.

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

getRevision

public Revision[] getRevision()
Method getRevision.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

getRevisionAsReference

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

Returns:
a reference to the Vector backing this class

getRevisionCount

public int getRevisionCount()
Method getRevisionCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

iterateRevision

public java.util.Iterator<? extends Revision> iterateRevision()
Method iterateRevision.

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

removeAllRevision

public void removeAllRevision()

removeRevision

public boolean removeRevision(Revision vRevision)
Method removeRevision.

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

removeRevisionAt

public Revision removeRevisionAt(int index)
Method removeRevisionAt.

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

setContinuation

public void setContinuation(Continuation continuation)
Sets the value of field 'continuation'.

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

setRevision

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

setRevision

public void setRevision(Revision[] vRevisionArray)
Parameters:
vRevisionArray -

setRevision

public void setRevision(java.util.List<Revision> vRevisionList)
Sets the value of '_revisionList' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vRevisionList - the Vector to copy.

setRevisionAsReference

public void setRevisionAsReference(java.util.List<Revision> revisionList)
Deprecated. 

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

Parameters:
revisionList - the Vector to set.

unmarshalEditHistory

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

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