All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class edu.vt.marian.Document.RFC1807Document

java.lang.Object
   |
   +----edu.vt.marian.Document.RFC1807Document

public class RFC1807Document
extends Object
implements Document
A set of data encapsulated in a SOIF


Constructor Index

 o RFC1807Document(Debug)
Build a new SOIF object
 o RFC1807Document(String, Debug)
Build a new SOIF object from an input stream

Method Index

 o attributes()
 o attributes(int)
 o copy()
 o GetAttributeNames()
Return a string array of the attribute names in this SOIF
 o GetAttributeValue(String)
Return the value of a specified attribute in this SOIF
 o GetNumAttributes()
Return a count of the number of attributes in this SOIF
 o isValid()
 o ParseSOIFBody(String)
Parse the body of the SOIF extracting the attribute/value pairs
 o ParseSOIFBuffer(String)
Parse a marshalled SOIF object extracting all its attribute/value pairs
 o presentAttribute(int, int)
 o presentAttributes(int)
 o presentFull(int)
 o presentFull(int, BufferedWriter)
 o presentLong(int)
 o presentLong(int, BufferedWriter)
 o presentShort(int)
Return a short description (probably only one sentence) of the document this represents.
 o presentShort(int, BufferedWriter)
 o SetAttributeValue(String, String)
Set an attribute/value pair for this SOIF
 o SOIFClose()
Return the SOIF close symbol (the brace)
 o SOIFToBuffer(boolean)
Return a StringBuffer which is a marshalled version of this SOIF
 o UnparseSOIFElement(String, String)
Turn a attribute/value pair into a strintg.

Constructors

 o RFC1807Document
 public RFC1807Document(Debug debug)
Build a new SOIF object

 o RFC1807Document
 public RFC1807Document(String rfc1807Input,
                        Debug debug) throws SOIFException
Build a new SOIF object from an input stream

Parameters:
soifInput - input stream from which the SOIF should be built.

Methods

 o GetAttributeNames
 public String[] GetAttributeNames()
Return a string array of the attribute names in this SOIF

Returns:
An array of String that are the attribute (property) names for the SOIF instance
 o GetNumAttributes
 public int GetNumAttributes()
Return a count of the number of attributes in this SOIF

 o GetAttributeValue
 public String GetAttributeValue(String attribute)
Return the value of a specified attribute in this SOIF

Parameters:
attribute - name of the attribute to get the value of.
 o SetAttributeValue
 public void SetAttributeValue(String attribute,
                               String value)
Set an attribute/value pair for this SOIF

Parameters:
attribute - name of the attribute to set.
value - value to set the attribute to.
 o SOIFToBuffer
 public StringBuffer SOIFToBuffer(boolean close)
Return a StringBuffer which is a marshalled version of this SOIF

Parameters:
close - A boolean value determining whether the soif should be closed (I.E. whether the closing brace should be appended to the soif).
 o UnparseSOIFElement
 public static String UnparseSOIFElement(String attribute,
                                         String value)
Turn a attribute/value pair into a strintg.

Parameters:
attribute - The attribute
value - The attribute's value.
 o SOIFClose
 public String SOIFClose()
Return the SOIF close symbol (the brace)

 o ParseSOIFBuffer
 public void ParseSOIFBuffer(String soifString) throws SOIFException
Parse a marshalled SOIF object extracting all its attribute/value pairs

Parameters:
soifString - the string to parse.
 o ParseSOIFBody
 public void ParseSOIFBody(String body) throws SOIFException
Parse the body of the SOIF extracting the attribute/value pairs

Parameters:
body - the body to parse
 o presentShort
 public String presentShort(int markupType)
Return a short description (probably only one sentence) of the document this represents.

Parameters:
markupType - -- specifies the charater set type need to be returned
Returns:
the short description of this object as a string
 o presentShort
 public int presentShort(int markupType,
                         BufferedWriter out) throws IOException
 o presentLong
 public String presentLong(int markupType)
 o presentLong
 public int presentLong(int markupType,
                        BufferedWriter out) throws IOException
 o isValid
 public boolean isValid()
 o copy
 public DigInfObj copy()
 o presentFull
 public String presentFull(int markupType)
 o attributes
 public Vector attributes()
 o attributes
 public Vector attributes(int markupType)
 o presentAttributes
 public Vector presentAttributes(int markupType)
 o presentAttribute
 public Object presentAttribute(int attrID,
                                int markupType)
 o presentFull
 public int presentFull(int markupType,
                        BufferedWriter out) throws IOException

All Packages  Class Hierarchy  This Package  Previous  Next  Index