net.sf.tomp.xtcl
Class Context

java.lang.Object
  extended by net.sf.tomp.xtcl.Context

public class Context
extends java.lang.Object

Context for compilation, execution, creating XMLReaders, XMLFilters Resolvers, Transformations etc

Author:
tomp

Field Summary
protected static java.lang.Class resolvingXMLReaderClass
           
protected static java.lang.Class uriResolverClass
           
 
Constructor Summary
Context()
          Creates a new instance of Context from scratch
Context(Context p)
          Creates a new instance of Context, copying all data from the given parent Context.
 
Method Summary
 void addCompiler(Compiler comp)
          Adds a Compiler to the compilers' list at the position 0 {start}
protected  void addCompiler(int index, Compiler comp)
           
 void dump(boolean deep)
          Dumps the Context content, i.e. variables
 void dumpAll(boolean deep)
          Dumps not just this Context and also all its ancestors.
 void dumpVariable(java.lang.Object k)
          Dumps one variable identified by the key.
 int execute(Command command)
          Executes a command in the current context
 java.lang.Object get(java.lang.Object ref)
          Gets an object from Context - if not found here, recursively recursively calls get on previous Context
 Compiler getCompiler()
           
protected  Compiler getCompiler(int index)
           
 int getCompilerCount()
          Returns count of all compilers in this Context
 int getDepth()
          returns the context's depth
 javax.xml.parsers.DocumentBuilder getDocumentBuilder()
          Returns the DocumentBuilder registered with this Context
 javax.xml.transform.Transformer getEmptyTransformer()
          Returns a do-nothing Transformer.
 java.io.File getFile(java.lang.String n)
          Get a File relative to the realPath (current directory) of this Context.
 net.sf.joost.trax.TransformerFactoryImpl getJoostTransformerFactory()
          DOCUMENT ME!
 Compiler getNextCompiler(Compiler c)
           
 java.io.PrintStream getOut()
          Gets the Context's standard out PrintStream
 Context getPrevious()
          Returns the previous (parent) Context
 java.io.File getRealPath()
          Returns the Context's real path (root directory) used to resolve relative filenames
static java.lang.Class getResolvingXMLReaderClass()
           
 javax.xml.parsers.SAXParserFactory getSAXParserFactory()
          Returns the registered SAXParserFactory
 javax.xml.transform.sax.SAXTransformerFactory getTransformerFactory()
          Returns the registered SAXTransformerFactory
 javax.xml.transform.URIResolver getUriResolver()
           
static java.lang.Class getUriResolverClass()
           
 XTFilterFactory getXTFilterFactory()
          DOCUMENT ME!
 XTSourceFactory getXTSourceFactory()
          DOCUMENT ME!
 boolean isExtraVerbose()
           
 boolean isStrictPassing()
          Is the parameter passing strict?
 boolean isVerbose()
           
 void put(java.lang.Object ref, java.lang.Object value)
          DOCUMENT ME!
 java.io.File refToFile(java.lang.Object ref)
          DOCUMENT ME!
 org.xml.sax.InputSource refToInputSource(java.lang.Object ref)
          DOCUMENT ME!
 javax.xml.transform.Templates refToJoostStyle(java.lang.Object ref)
          DOCUMENT ME!
 java.util.Properties refToProperties(java.lang.Object ref)
           
 javax.xml.transform.Result refToResult(java.lang.Object ref)
          public Object refToTransformParam(Object ref, Context context) { Object o = context.get(ref); //System.out.println("refToTransformParam="+o); if (o instanceof Document) { return new DOMSource((Document)o); } else if (o instanceof File) { return new StreamSource((File)o); } return o; }
 javax.xml.transform.Source refToSource(java.lang.Object ref)
          DOCUMENT ME!
 javax.xml.transform.Templates refToStyle(java.lang.Object ref)
          DOCUMENT ME!
 Template refToTemplate(java.lang.Object ref)
           
 org.xml.sax.XMLFilter refToXMLFilter(java.lang.Object ref)
          DOCUMENT ME!
 java.lang.Object remove(java.lang.Object ref)
          Removes an object from Context
 void removeCompiler()
          Removes the first Compiler from the list
protected  void removeCompiler(int index)
           
 void setExtraVerbose(boolean extraVerbose)
           
 void setOut(java.io.PrintStream o)
          DOCUMENT ME!
 void setRealPath(java.io.File f)
          DOCUMENT ME!
static void setResolvingXMLReaderClass(java.lang.Class resolvingXMLReaderClass)
           
 void setStrictPassing(boolean b)
          Sets the parameter passing to be strict
 void setUriResolver(javax.xml.transform.URIResolver uriResolver)
           
static void setUriResolverClass(java.lang.Class uriResolverClass)
           
 void setVerbose(boolean verbose)
           
 void setXTFilterFactory(XTFilterFactory f)
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

uriResolverClass

protected static java.lang.Class uriResolverClass

resolvingXMLReaderClass

protected static java.lang.Class resolvingXMLReaderClass
Constructor Detail

Context

public Context()
        throws javax.xml.parsers.ParserConfigurationException,
               javax.xml.transform.TransformerConfigurationException,
               java.io.IOException,
               java.lang.InstantiationException,
               java.lang.IllegalAccessException,
               java.lang.ClassNotFoundException
Creates a new instance of Context from scratch

Throws:
javax.xml.parsers.ParserConfigurationException - DOCUMENT ME!
javax.xml.transform.TransformerConfigurationException - DOCUMENT ME!
java.io.IOException - DOCUMENT ME!
java.lang.ClassNotFoundException
java.lang.IllegalAccessException
java.lang.InstantiationException

Context

public Context(Context p)
        throws javax.xml.parsers.ParserConfigurationException,
               javax.xml.transform.TransformerConfigurationException,
               java.lang.InstantiationException,
               java.lang.IllegalAccessException,
               java.lang.ClassNotFoundException
Creates a new instance of Context, copying all data from the given parent Context.

Parameters:
p - parent Context
Throws:
javax.xml.parsers.ParserConfigurationException - DOCUMENT ME!
javax.xml.transform.TransformerConfigurationException - DOCUMENT ME!
java.lang.ClassNotFoundException
java.lang.IllegalAccessException
java.lang.InstantiationException
Method Detail

addCompiler

public void addCompiler(Compiler comp)
Adds a Compiler to the compilers' list at the position 0 {start}

Parameters:
comp - Compiler to be added

addCompiler

protected void addCompiler(int index,
                           Compiler comp)

removeCompiler

public void removeCompiler()
Removes the first Compiler from the list


removeCompiler

protected void removeCompiler(int index)

dump

public void dump(boolean deep)
          throws java.lang.Exception
Dumps the Context content, i.e. variables

Parameters:
deep - dump deeply, i.e. also variables context
Throws:
java.lang.Exception - if dump of any variable fails

dumpAll

public void dumpAll(boolean deep)
             throws java.lang.Exception
Dumps not just this Context and also all its ancestors.

Parameters:
deep - dump deeply, i.e. also variables context
Throws:
java.lang.Exception - if dump of any variable fails

dumpVariable

public void dumpVariable(java.lang.Object k)
                  throws java.lang.Exception
Dumps one variable identified by the key.

Parameters:
k - the variable key (usually a String name)
Throws:
java.lang.Exception - if dump of this variable fails, for example if XML output fails

execute

public int execute(Command command)
            throws java.lang.Exception
Executes a command in the current context

Parameters:
command - to be executed
Returns:
return code from execution
Throws:
java.lang.Exception - if the command fails, an unspecified Exception is thrown

get

public java.lang.Object get(java.lang.Object ref)
Gets an object from Context - if not found here, recursively recursively calls get on previous Context

Parameters:
ref - the key
Returns:
the object found or null

remove

public java.lang.Object remove(java.lang.Object ref)
Removes an object from Context

Parameters:
ref - the key
Returns:
the object found or null

getCompilerCount

public int getCompilerCount()
Returns count of all compilers in this Context

Returns:
count of all compilers in this Context

getCompiler

public Compiler getCompiler()

getCompiler

protected Compiler getCompiler(int index)

getDepth

public int getDepth()
returns the context's depth

Returns:
the context's depth

getDocumentBuilder

public javax.xml.parsers.DocumentBuilder getDocumentBuilder()
Returns the DocumentBuilder registered with this Context

Returns:
DocumentBuilder registered with this Context

getEmptyTransformer

public javax.xml.transform.Transformer getEmptyTransformer()
Returns a do-nothing Transformer.

Returns:
a do-nothing Transformer

getFile

public java.io.File getFile(java.lang.String n)
Get a File relative to the realPath (current directory) of this Context. If an absolute filename n is given, returns directly a File(n).

Parameters:
f - the (relative or absolute) file name
Returns:
the File

getJoostTransformerFactory

public net.sf.joost.trax.TransformerFactoryImpl getJoostTransformerFactory()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getNextCompiler

public Compiler getNextCompiler(Compiler c)

getOut

public java.io.PrintStream getOut()
Gets the Context's standard out PrintStream

Returns:
the Context's standard out PrintStream

getPrevious

public Context getPrevious()
Returns the previous (parent) Context

Returns:
the previous (parent) Context

getRealPath

public java.io.File getRealPath()
Returns the Context's real path (root directory) used to resolve relative filenames

Returns:
the Context's real path

getSAXParserFactory

public javax.xml.parsers.SAXParserFactory getSAXParserFactory()
Returns the registered SAXParserFactory

Returns:
the registered SAXParserFactory

getTransformerFactory

public javax.xml.transform.sax.SAXTransformerFactory getTransformerFactory()
Returns the registered SAXTransformerFactory

Returns:
the registered SAXTransformerFactory

getXTFilterFactory

public XTFilterFactory getXTFilterFactory()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getXTSourceFactory

public XTSourceFactory getXTSourceFactory()
DOCUMENT ME!

Returns:
DOCUMENT ME!

isStrictPassing

public boolean isStrictPassing()
Is the parameter passing strict?

Returns:
true iff parameter passing is strict

isVerbose

public boolean isVerbose()
Returns:
Returns the verbose.

put

public void put(java.lang.Object ref,
                java.lang.Object value)
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
value - DOCUMENT ME!

setOut

public void setOut(java.io.PrintStream o)
DOCUMENT ME!

Parameters:
o - DOCUMENT ME!

setRealPath

public void setRealPath(java.io.File f)
DOCUMENT ME!

Parameters:
f - DOCUMENT ME!

setStrictPassing

public void setStrictPassing(boolean b)
Sets the parameter passing to be strict

Parameters:
b - DOCUMENT ME!

setVerbose

public void setVerbose(boolean verbose)
Parameters:
verbose - The verbose to set.

setXTFilterFactory

public void setXTFilterFactory(XTFilterFactory f)
DOCUMENT ME!

Parameters:
f - DOCUMENT ME!

refToFile

public java.io.File refToFile(java.lang.Object ref)
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

refToProperties

public java.util.Properties refToProperties(java.lang.Object ref)

refToTemplate

public Template refToTemplate(java.lang.Object ref)

refToXMLFilter

public org.xml.sax.XMLFilter refToXMLFilter(java.lang.Object ref)
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

refToSource

public javax.xml.transform.Source refToSource(java.lang.Object ref)
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

refToInputSource

public org.xml.sax.InputSource refToInputSource(java.lang.Object ref)
                                         throws java.io.IOException
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.io.IOException - DOCUMENT ME!
java.lang.IllegalArgumentException - DOCUMENT ME!

refToStyle

public javax.xml.transform.Templates refToStyle(java.lang.Object ref)
                                         throws javax.xml.transform.TransformerConfigurationException
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
javax.xml.transform.TransformerConfigurationException - DOCUMENT ME!

refToJoostStyle

public javax.xml.transform.Templates refToJoostStyle(java.lang.Object ref)
                                              throws javax.xml.transform.TransformerConfigurationException
DOCUMENT ME!

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
javax.xml.transform.TransformerConfigurationException - DOCUMENT ME!

refToResult

public javax.xml.transform.Result refToResult(java.lang.Object ref)
public Object refToTransformParam(Object ref, Context context) { Object o = context.get(ref); //System.out.println("refToTransformParam="+o); if (o instanceof Document) { return new DOMSource((Document)o); } else if (o instanceof File) { return new StreamSource((File)o); } return o; }

Parameters:
ref - DOCUMENT ME!
context - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.lang.IllegalArgumentException - DOCUMENT ME!

getResolvingXMLReaderClass

public static java.lang.Class getResolvingXMLReaderClass()
Returns:
Returns the resolvingXMLReaderClass.

setResolvingXMLReaderClass

public static void setResolvingXMLReaderClass(java.lang.Class resolvingXMLReaderClass)
Parameters:
resolvingXMLReaderClass - The resolvingXMLReaderClass to set.

getUriResolverClass

public static java.lang.Class getUriResolverClass()
Returns:
Returns the uriResolverClass.

setUriResolverClass

public static void setUriResolverClass(java.lang.Class uriResolverClass)
Parameters:
uriResolverClass - The uriResolverClass to set.

isExtraVerbose

public boolean isExtraVerbose()
Returns:
Returns the extraVerbose.

setExtraVerbose

public void setExtraVerbose(boolean extraVerbose)
Parameters:
extraVerbose - The extraVerbose to set.

getUriResolver

public javax.xml.transform.URIResolver getUriResolver()
Returns:
Returns the uriResolver.

setUriResolver

public void setUriResolver(javax.xml.transform.URIResolver uriResolver)
Parameters:
uriResolver - The uriResolver to set.


Copyright © 2004-2005 Masaryk University in Brno, Faculty of Informatics, Czech Republic. All Rights Reserved.