TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.report.drivers.html
Class ConfParser

java.lang.Object
  extended byorg.eclipse.tptp.platform.report.drivers.html.ConfParser

public class ConfParser
extends java.lang.Object

This class contains an html writer parser configuration. This configuration is read from the dhtml.xml file standing in the same path than this class. Configuration allows to set some of the html generated for a JScrib item.


Constructor Summary
ConfParser()
          Create a root html configuration parser
ConfParser(java.lang.String file_name, ConfParser parent)
          Create a secondary html configuration parser.
 
Method Summary
protected  void checkItemChild(org.eclipse.tptp.platform.report.drivers.internal.Item item, org.w3c.dom.Node n)
          redefine this method if you are interested in <item> child node
 void dump()
           
static void dump(java.lang.String indent, java.lang.String name, int value)
           
static void dump(java.lang.String indent, java.lang.String name, java.util.List list)
           
static void dump(java.lang.String indent, java.lang.String name, java.lang.String value)
           
 org.eclipse.tptp.platform.report.drivers.internal.ConvertText getConvertText()
           
 org.eclipse.tptp.platform.report.drivers.internal.HtmlFile getHtmlFile()
           
 org.eclipse.tptp.platform.report.drivers.internal.Item getItem(java.lang.Class class_)
           
 ConfParser getParentConfParser()
           
 java.lang.String getVariableValue(java.lang.String name)
           
 void initVariable(java.lang.String name)
          Initialize a new variable for this parser, all new variable added by a parser extension must be initalized using this method.
 boolean isDefinedVariable(java.lang.String name)
           
 boolean isTTFont(java.lang.String name)
           
 boolean parse()
           
 void setParentConfParser(ConfParser p)
          Change actual configuration parser
 void setVariableValue(java.lang.String name, java.lang.String value, java.lang.Object owner)
          Change value of variable in this parser or parent depending of which one define it.
 void unsetVariables(java.lang.Object owner)
          unset variable in this parser and parent parser (if any)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfParser

public ConfParser()
Create a root html configuration parser


ConfParser

public ConfParser(java.lang.String file_name,
                  ConfParser parent)
Create a secondary html configuration parser. In other words this parser extends parent parser features, to do it do not forget to call setParentConfParser() with extended parser. Html variables added to secondary parser must be initalized using initVariable() method.

Method Detail

setParentConfParser

public void setParentConfParser(ConfParser p)
Change actual configuration parser


getParentConfParser

public ConfParser getParentConfParser()
Returns:
actual parent configuration parser, null if none

parse

public boolean parse()

isTTFont

public boolean isTTFont(java.lang.String name)

isDefinedVariable

public boolean isDefinedVariable(java.lang.String name)
Returns:
true if variable is defined by this parser or parent one

getVariableValue

public java.lang.String getVariableValue(java.lang.String name)
Returns:
variable value defined in this parser of parent one

setVariableValue

public void setVariableValue(java.lang.String name,
                             java.lang.String value,
                             java.lang.Object owner)
Change value of variable in this parser or parent depending of which one define it.


unsetVariables

public void unsetVariables(java.lang.Object owner)
unset variable in this parser and parent parser (if any)


initVariable

public void initVariable(java.lang.String name)
Initialize a new variable for this parser, all new variable added by a parser extension must be initalized using this method.


getItem

public org.eclipse.tptp.platform.report.drivers.internal.Item getItem(java.lang.Class class_)
Returns:
item for given class from this parser or parent parser

checkItemChild

protected void checkItemChild(org.eclipse.tptp.platform.report.drivers.internal.Item item,
                              org.w3c.dom.Node n)
                       throws org.eclipse.tptp.platform.report.drivers.internal.ConfSemanticException
redefine this method if you are interested in <item> child node

Throws:
org.eclipse.tptp.platform.report.drivers.internal.ConfSemanticException

dump

public static void dump(java.lang.String indent,
                        java.lang.String name,
                        java.lang.String value)

dump

public static void dump(java.lang.String indent,
                        java.lang.String name,
                        int value)

dump

public static void dump(java.lang.String indent,
                        java.lang.String name,
                        java.util.List list)

getHtmlFile

public org.eclipse.tptp.platform.report.drivers.internal.HtmlFile getHtmlFile()
Returns:
parent's html file of this html file if this parser is root parser

getConvertText

public org.eclipse.tptp.platform.report.drivers.internal.ConvertText getConvertText()

dump

public void dump()

TPTP 4.2.0 Platform Project
Public API Specification