com.xmlmind.xml.xed

Class Script

java.lang.Object

com.xmlmind.xml.xed.Script

All Implemented Interfaces:

NamespacePrefixMap, NamespaceToPrefixes, PrefixToNamespace

public final class Script
extends Object
implements NamespacePrefixMap

A parsed, ready-to-run, XED script.

This class is thread-safe.

Field Summary

Fields inherited from interface com.xmlmind.xml.name.NamespaceToPrefixes

EMPTY_PREFIXES, XML_PREFIXES

Constructor Summary

Constructors

Constructor and Description
Script()

Method Summary

Modifier and Type	Method and Description
void	addAction(com.xmlmind.xml.xed.Action action)
void	addMacro(com.xmlmind.xml.xed.MacroCmd macro)
void	declareNamespace(String prefix, Namespace namespace)
void	declareNamespace(String prefix, String uri)
com.xmlmind.xml.xed.Action[]	getActions()
com.xmlmind.xml.xed.MacroCmd	getMacro(String name)
com.xmlmind.xml.xed.MacroCmd[]	getMacros()
PrefixEntry[]	getNamespacePrefixes()
URL	getURL()
String[]	namespaceToPrefixes(Namespace namespace) Returns the list of prefixes used to represent specified namespace.
Namespace	prefixToNamespace(String prefix) Returns namespace represented by specified prefix.
void	resolveCommands()
void	run(Document doc, Console console)
void	run(ScriptExprContext context, Console console)
void	run(XNode contextNode, ExprContext context, Console console)
void	setURL(URL url)
String	toString()
void	toString(StringBuilder buffer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Script

public Script()

Method Detail

setURL

public void setURL(URL url)

getURL

public URL getURL()

declareNamespace

public void declareNamespace(String prefix,
                             String uri)

declareNamespace

public void declareNamespace(String prefix,
                             Namespace namespace)

getNamespacePrefixes

public PrefixEntry[] getNamespacePrefixes()

addMacro

public void addMacro(com.xmlmind.xml.xed.MacroCmd macro)

getMacro

public com.xmlmind.xml.xed.MacroCmd getMacro(String name)

getMacros

public com.xmlmind.xml.xed.MacroCmd[] getMacros()

addAction

public void addAction(com.xmlmind.xml.xed.Action action)

getActions

public com.xmlmind.xml.xed.Action[] getActions()

resolveCommands

public void resolveCommands()
                     throws ScriptLoadException

Throws:

ScriptLoadException

run

public void run(Document doc,
                Console console)
         throws com.xmlmind.xml.xed.ActionException

Throws:

com.xmlmind.xml.xed.ActionException

run

public void run(ScriptExprContext context,
                Console console)
         throws com.xmlmind.xml.xed.ActionException

Throws:

com.xmlmind.xml.xed.ActionException

run

public void run(XNode contextNode,
                ExprContext context,
                Console console)
         throws com.xmlmind.xml.xed.ActionException

Throws:

com.xmlmind.xml.xed.ActionException

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(StringBuilder buffer)

prefixToNamespace

public Namespace prefixToNamespace(String prefix)

Description copied from interface: PrefixToNamespace

Returns namespace represented by specified prefix.

The empty string may be used to get the prefix of the default namespace.

Note: In principle, this method is not invoked for prefix "xml". However, in such case, it should return Namespace.XML.

Specified by:

prefixToNamespace in interface PrefixToNamespace

Parameters:

prefix - prefix representing a namespace. May be the empty string ("").

Returns:

namespace represented by specified prefix or null if prefix is unknown (that is, not used to represent any namespace).

namespaceToPrefixes

public String[] namespaceToPrefixes(Namespace namespace)

Description copied from interface: NamespaceToPrefixes

Returns the list of prefixes used to represent specified namespace.

The returned list may contain the empty string which means that specified namespace is the default namespace.

Note:In principle, this method is not invoked for the absent namespace ("") and for "http://www.w3.org/XML/1998/namespace". However, it should return NamespaceToPrefixes.EMPTY_PREFIXES for the absent namespace and NamespaceToPrefixes.XML_PREFIXES for the "http://www.w3.org/XML/1998/namespace" namespace.

Specified by:

namespaceToPrefixes in interface NamespaceToPrefixes

Parameters:

namespace - the namespace represented by one or several prefixes

Returns:

the list of prefixes used to represent specified namespace or null if specified namespace is not represented by any prefix.