All Packages Class Hierarchy This Package Previous Next Index
Class edu.vt.marian.Document.SOIFDocument
java.lang.Object
|
+----edu.vt.marian.Document.SOIFDocument
- public class SOIFDocument
- extends Object
- implements Document
A set of data encapsulated in a SOIF
-
soifString
- this string contains all the information of this document
the format of the string is in SGML
-
SOIFDocument(Debug)
- Build a new SOIF object
-
SOIFDocument(String, Debug)
- Build a new SOIF object from an input stream
-
attributes()
-
-
attributes(int)
-
-
copy()
-
-
GetAttributeNames()
- Return a string array of the attribute names in this SOIF
-
GetAttributeValue(String)
- Return the value of a specified attribute in this SOIF
-
GetNumAttributes()
- Return a count of the number of attributes in this SOIF
-
GetTemplateType()
- Return the template type of this SOIF object.
-
GetURL()
- Return the URL of this SOIF object
-
isValid()
-
-
ParseSOIFBody(String)
- Parse the body of the SOIF extracting the attribute/value pairs
-
ParseSOIFBuffer(String)
- Parse a marshalled SOIF object extracting all its attribute/value
pairs
-
presentAttribute(int, int)
-
-
presentAttributes(int)
-
-
presentFull(int)
-
-
presentFull(int, BufferedWriter)
-
-
presentLong(int)
-
-
presentLong(int, BufferedWriter)
-
-
presentShort(int)
- Return a short description
(probably only one sentence) of the document this represents.
-
presentShort(int, BufferedWriter)
-
-
SetAttributeValue(String, String)
- Set an attribute/value pair for this SOIF
-
SOIFClose()
- Return the SOIF close symbol (the brace)
-
SOIFToBuffer(boolean)
- Return a StringBuffer which is a marshalled version of this SOIF
-
UnparseSOIFElement(String, String)
- Turn a attribute/value pair into a strintg.
soifString
public String soifString
- this string contains all the information of this document
the format of the string is in SGML
SOIFDocument
public SOIFDocument(Debug debug)
- Build a new SOIF object
SOIFDocument
public SOIFDocument(String soifInput,
Debug debug) throws SOIFException
- Build a new SOIF object from an input stream
- Parameters:
- soifInput - input stream from which the SOIF should be built.
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
GetNumAttributes
public int GetNumAttributes()
- Return a count of the number of attributes in this SOIF
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.
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.
GetTemplateType
public String GetTemplateType()
- Return the template type of this SOIF object.
GetURL
public URL GetURL()
- Return the URL of this SOIF object
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).
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.
SOIFClose
public String SOIFClose()
- Return the SOIF close symbol (the brace)
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.
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
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
presentShort
public int presentShort(int markupType,
BufferedWriter out) throws IOException
presentLong
public String presentLong(int markupType)
presentLong
public int presentLong(int markupType,
BufferedWriter out) throws IOException
isValid
public boolean isValid()
copy
public DigInfObj copy()
presentFull
public String presentFull(int markupType)
attributes
public Vector attributes()
attributes
public Vector attributes(int markupType)
presentAttributes
public Vector presentAttributes(int markupType)
presentAttribute
public Object presentAttribute(int attrID,
int markupType)
presentFull
public int presentFull(int markupType,
BufferedWriter out) throws IOException
All Packages Class Hierarchy This Package Previous Next Index