net.sf.sqs_xml.reader.model
Class Page

java.lang.Object
  extended bynet.sf.sqs_xml.reader.model.Page
All Implemented Interfaces:
java.lang.Cloneable, IRNode, IRNSContainer, java.io.Serializable

public class Page
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, IRNSContainer, IRNode

Page is generated from reader.rng by Relaxer. This class is derived from:

 <element name="page" ns="http://sqs.cmr.sfc.keio.ac.jp/2004/reader">
                   <attribute name="sampleID">
 						<data type="int"/>
 	              </attribute>      
                   <attribute name="number">
 						<data type="int"/>
 	              </attribute>                   
 
                   <optional>
                     <ref name="FormElements"/>
                   </optional>
 
                 </element>

Version:
reader.rng (Fri Aug 06 03:48:33 GMT+09:00 2004)
Author:
Relaxer 1.1b (http://www.relaxer.org)
See Also:
Serialized Form

Constructor Summary
Page()
          Creates a Page.
Page(org.w3c.dom.Document doc)
          Creates a Page by the Document doc.
Page(org.w3c.dom.Element element)
          Creates a Page by the Element element.
Page(java.io.File file)
          Creates a Page by the File file.
Page(org.xml.sax.InputSource is)
          Creates a Page by the InputSource is.
Page(java.io.InputStream in)
          Creates a Page by the InputStream in.
Page(Page source)
          Creates a Page.
Page(java.io.Reader reader)
          Creates a Page by the Reader reader.
Page(RStack stack)
          Creates a Page by the Stack stack that contains Elements.
Page(java.lang.String uri)
          Creates a Page by the String representation of URI uri.
Page(java.net.URL url)
          Creates a Page by the URL url.
 
Method Summary
 void addFormElements(IFormElementsChoice formElements)
          Adds the IFormElementsChoice property FormElements.
 void addFormElements(IFormElementsChoice[] formElements)
          Adds the IFormElementsChoice property FormElements.
 void addFormElements(int index, IFormElementsChoice formElements)
          Adds the IFormElementsChoice property FormElements by index.
 void clearFormElements()
          Clear the IFormElementsChoice property FormElements.
 java.lang.Object clone()
           
 IFormElementsChoice[] getFormElements()
          Gets the IFormElementsChoice property FormElements.
 IFormElementsChoice getFormElements(int index)
          Gets the IFormElementsChoice property FormElements by index.
 int getNumber()
          Gets the int property number.
 java.lang.String getNumberAsString()
          Gets the property value as String.
 int getSampleID()
          Gets the int property sampleID.
 java.lang.String getSampleIDAsString()
          Gets the property value as String.
static boolean isMatch(org.w3c.dom.Element element)
          Tests if a Element element is valid for the Page.
static boolean isMatch(RStack stack)
          Tests if elements contained in a Stack stack is valid for the Page.
static boolean isMatchHungry(RStack stack)
          Tests if elements contained in a Stack stack is valid for the Page.
 org.w3c.dom.Document makeDocument()
          Creates a DOM document representation of the object.
 void makeElement(org.w3c.dom.Node parent)
          Creates a DOM representation of the object.
 void makeTextAttribute(java.io.PrintWriter buffer)
          Makes an XML text representation.
 void makeTextAttribute(java.lang.StringBuffer buffer)
          Makes an XML text representation.
 void makeTextAttribute(java.io.Writer buffer)
          Makes an XML text representation.
 java.lang.String makeTextDocument()
          Makes an XML text representation.
 void makeTextElement(java.io.PrintWriter buffer)
          Makes an XML text representation.
 void makeTextElement(java.lang.StringBuffer buffer)
          Makes an XML text representation.
 void makeTextElement(java.io.Writer buffer)
          Makes an XML text representation.
 void removeFormElements(IFormElementsChoice formElements)
          Remove the IFormElementsChoice property FormElements by object.
 void removeFormElements(int index)
          Remove the IFormElementsChoice property FormElements by index.
 org.w3c.dom.Element rGetElement()
          Gets the element to be used in the object construction.
 IRNode rGetParentRNode()
          Gets the IRNode property parentRNode.
 IRNode[] rGetRNodes()
          Gets child RNodes.
 RNSContext rGetRNSContext()
          Gets the RNSContext property RNSContext.
 void rSetParentRNode(IRNode parentRNode)
          Sets the IRNode property parentRNode.
 void rSetRNSContext(RNSContext rNSContext)
          Sets the RNSContext property RNSContext.
 void setFormElements(IFormElementsChoice formElements)
          Sets the IFormElementsChoice property FormElements.
 void setFormElements(IFormElementsChoice[] formElements)
          Sets the IFormElementsChoice property FormElements.
 void setFormElements(int index, IFormElementsChoice formElements)
          Sets the IFormElementsChoice property FormElements by index.
 void setNumber(int number)
          Sets the int property number.
 void setNumberByString(java.lang.String string)
          Sets the property value by String.
 void setSampleID(int sampleID)
          Sets the int property sampleID.
 void setSampleIDByString(java.lang.String string)
          Sets the property value by String.
 void setup(org.w3c.dom.Document doc)
          Initializes the Page by the Document doc.
 void setup(org.w3c.dom.Element element)
          Initializes the Page by the Element element.
 void setup(java.io.File file)
          Initializes the Page by the File file.
 void setup(org.xml.sax.InputSource is)
          Initializes the Page by the InputSource is.
 void setup(java.io.InputStream in)
          Initializes the Page by the InputStream in.
 void setup(Page source)
          Initializes the Page by the Page source.
 void setup(java.io.Reader reader)
          Initializes the Page by the Reader reader.
 void setup(RStack stack)
          Initializes the Page by the Stack stack that contains Elements.
 void setup(java.lang.String uri)
          Initializes the Page by the String representation of URI uri.
 void setup(java.net.URL url)
          Initializes the Page by the URL url.
 int sizeFormElements()
          Gets number of the IFormElementsChoice property FormElements.
 java.lang.String toString()
          Returns a String representation of this object.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Page

public Page()
Creates a Page.


Page

public Page(Page source)
Creates a Page.

Parameters:
source -

Page

public Page(RStack stack)
Creates a Page by the Stack stack that contains Elements. This constructor is supposed to be used internally by the Relaxer system.

Parameters:
stack -

Page

public Page(org.w3c.dom.Document doc)
Creates a Page by the Document doc.

Parameters:
doc -

Page

public Page(org.w3c.dom.Element element)
Creates a Page by the Element element.

Parameters:
element -

Page

public Page(java.io.File file)
     throws java.io.IOException,
            org.xml.sax.SAXException,
            javax.xml.parsers.ParserConfigurationException
Creates a Page by the File file.

Parameters:
file -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

Page

public Page(java.lang.String uri)
     throws java.io.IOException,
            org.xml.sax.SAXException,
            javax.xml.parsers.ParserConfigurationException
Creates a Page by the String representation of URI uri.

Parameters:
uri -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

Page

public Page(java.net.URL url)
     throws java.io.IOException,
            org.xml.sax.SAXException,
            javax.xml.parsers.ParserConfigurationException
Creates a Page by the URL url.

Parameters:
url -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

Page

public Page(java.io.InputStream in)
     throws java.io.IOException,
            org.xml.sax.SAXException,
            javax.xml.parsers.ParserConfigurationException
Creates a Page by the InputStream in.

Parameters:
in -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

Page

public Page(org.xml.sax.InputSource is)
     throws java.io.IOException,
            org.xml.sax.SAXException,
            javax.xml.parsers.ParserConfigurationException
Creates a Page by the InputSource is.

Parameters:
is -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

Page

public Page(java.io.Reader reader)
     throws java.io.IOException,
            org.xml.sax.SAXException,
            javax.xml.parsers.ParserConfigurationException
Creates a Page by the Reader reader.

Parameters:
reader -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException
Method Detail

setup

public void setup(Page source)
Initializes the Page by the Page source.

Parameters:
source -

setup

public void setup(org.w3c.dom.Document doc)
Initializes the Page by the Document doc.

Parameters:
doc -

setup

public void setup(org.w3c.dom.Element element)
Initializes the Page by the Element element.

Parameters:
element -

setup

public void setup(RStack stack)
Initializes the Page by the Stack stack that contains Elements. This constructor is supposed to be used internally by the Relaxer system.

Parameters:
stack -

clone

public java.lang.Object clone()
Returns:
Object

makeElement

public void makeElement(org.w3c.dom.Node parent)
Creates a DOM representation of the object. Result is appended to the Node parent.

Parameters:
parent -

setup

public void setup(java.io.File file)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException
Initializes the Page by the File file.

Parameters:
file -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

setup

public void setup(java.lang.String uri)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException
Initializes the Page by the String representation of URI uri.

Parameters:
uri -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

setup

public void setup(java.net.URL url)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException
Initializes the Page by the URL url.

Parameters:
url -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

setup

public void setup(java.io.InputStream in)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException
Initializes the Page by the InputStream in.

Parameters:
in -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

setup

public void setup(org.xml.sax.InputSource is)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException
Initializes the Page by the InputSource is.

Parameters:
is -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

setup

public void setup(java.io.Reader reader)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  javax.xml.parsers.ParserConfigurationException
Initializes the Page by the Reader reader.

Parameters:
reader -
Throws:
java.io.IOException
org.xml.sax.SAXException
javax.xml.parsers.ParserConfigurationException

makeDocument

public org.w3c.dom.Document makeDocument()
                                  throws javax.xml.parsers.ParserConfigurationException
Creates a DOM document representation of the object.

Returns:
Document
Throws:
javax.xml.parsers.ParserConfigurationException

rGetRNSContext

public RNSContext rGetRNSContext()
Gets the RNSContext property RNSContext.

Specified by:
rGetRNSContext in interface IRNSContainer
Returns:
RNSContext

rSetRNSContext

public void rSetRNSContext(RNSContext rNSContext)
Sets the RNSContext property RNSContext.

Parameters:
rNSContext -

getSampleID

public int getSampleID()
Gets the int property sampleID.

Returns:
int

setSampleID

public void setSampleID(int sampleID)
Sets the int property sampleID.

Parameters:
sampleID -

getNumber

public int getNumber()
Gets the int property number.

Returns:
int

setNumber

public void setNumber(int number)
Sets the int property number.

Parameters:
number -

getFormElements

public IFormElementsChoice[] getFormElements()
Gets the IFormElementsChoice property FormElements.

Returns:
IFormElementsChoice[]

setFormElements

public void setFormElements(IFormElementsChoice[] formElements)
Sets the IFormElementsChoice property FormElements.

Parameters:
formElements -

setFormElements

public void setFormElements(IFormElementsChoice formElements)
Sets the IFormElementsChoice property FormElements.

Parameters:
formElements -

addFormElements

public void addFormElements(IFormElementsChoice formElements)
Adds the IFormElementsChoice property FormElements.

Parameters:
formElements -

addFormElements

public void addFormElements(IFormElementsChoice[] formElements)
Adds the IFormElementsChoice property FormElements.

Parameters:
formElements -

sizeFormElements

public int sizeFormElements()
Gets number of the IFormElementsChoice property FormElements.

Returns:
int

getFormElements

public IFormElementsChoice getFormElements(int index)
Gets the IFormElementsChoice property FormElements by index.

Parameters:
index -
Returns:
IFormElementsChoice

setFormElements

public void setFormElements(int index,
                            IFormElementsChoice formElements)
Sets the IFormElementsChoice property FormElements by index.

Parameters:
index -
formElements -

addFormElements

public void addFormElements(int index,
                            IFormElementsChoice formElements)
Adds the IFormElementsChoice property FormElements by index.

Parameters:
index -
formElements -

removeFormElements

public void removeFormElements(int index)
Remove the IFormElementsChoice property FormElements by index.

Parameters:
index -

removeFormElements

public void removeFormElements(IFormElementsChoice formElements)
Remove the IFormElementsChoice property FormElements by object.

Parameters:
formElements -

clearFormElements

public void clearFormElements()
Clear the IFormElementsChoice property FormElements.


rGetElement

public org.w3c.dom.Element rGetElement()
Gets the element to be used in the object construction.

Returns:
Element

makeTextDocument

public java.lang.String makeTextDocument()
Makes an XML text representation.

Returns:
String

makeTextElement

public void makeTextElement(java.lang.StringBuffer buffer)
Makes an XML text representation.

Parameters:
buffer -

makeTextElement

public void makeTextElement(java.io.Writer buffer)
                     throws java.io.IOException
Makes an XML text representation.

Parameters:
buffer -
Throws:
java.io.IOException

makeTextElement

public void makeTextElement(java.io.PrintWriter buffer)
Makes an XML text representation.

Parameters:
buffer -

makeTextAttribute

public void makeTextAttribute(java.lang.StringBuffer buffer)
Makes an XML text representation.

Parameters:
buffer -

makeTextAttribute

public void makeTextAttribute(java.io.Writer buffer)
                       throws java.io.IOException
Makes an XML text representation.

Parameters:
buffer -
Throws:
java.io.IOException

makeTextAttribute

public void makeTextAttribute(java.io.PrintWriter buffer)
Makes an XML text representation.

Parameters:
buffer -

getSampleIDAsString

public java.lang.String getSampleIDAsString()
Gets the property value as String.

Returns:
String

getNumberAsString

public java.lang.String getNumberAsString()
Gets the property value as String.

Returns:
String

setSampleIDByString

public void setSampleIDByString(java.lang.String string)
Sets the property value by String.

Parameters:
string -

setNumberByString

public void setNumberByString(java.lang.String string)
Sets the property value by String.

Parameters:
string -

toString

public java.lang.String toString()
Returns a String representation of this object. While this method informs as XML format representaion, it's purpose is just information, not making a rigid XML documentation.

Returns:
String

rGetParentRNode

public IRNode rGetParentRNode()
Gets the IRNode property parentRNode.

Specified by:
rGetParentRNode in interface IRNode
Returns:
IRNode

rSetParentRNode

public void rSetParentRNode(IRNode parentRNode)
Sets the IRNode property parentRNode.

Specified by:
rSetParentRNode in interface IRNode
Parameters:
parentRNode -

rGetRNodes

public IRNode[] rGetRNodes()
Gets child RNodes.

Specified by:
rGetRNodes in interface IRNode
Returns:
IRNode[]

isMatch

public static boolean isMatch(org.w3c.dom.Element element)
Tests if a Element element is valid for the Page.

Parameters:
element -
Returns:
boolean

isMatch

public static boolean isMatch(RStack stack)
Tests if elements contained in a Stack stack is valid for the Page. This mehtod is supposed to be used internally by the Relaxer system.

Parameters:
stack -
Returns:
boolean

isMatchHungry

public static boolean isMatchHungry(RStack stack)
Tests if elements contained in a Stack stack is valid for the Page. This method consumes the stack contents during matching operation. This mehtod is supposed to be used internally by the Relaxer system.

Parameters:
stack -
Returns:
boolean