com.xml_project.morganaxproc.core
Class OptionValue

java.lang.Object
  com.xml_project.morganaxproc.core.OptionValue

public class OptionValue
extends java.lang.Object

This class represents the value of an option while executing an XProc pipeline.

Constructor Summary

OptionValue(javax.xml.namespace.QName name, boolean outer, XdmSequence value, java.lang.String baseURI, com.xml_project.xom.XOMUtilities.NamespaceMap namespaces, SequenceType type)
Creates a new option value.

OptionValue(javax.xml.namespace.QName name, java.lang.String baseURI, com.xml_project.xom.XOMUtilities.NamespaceMap namespaces, SequenceType type)
Creates a new option value.

OptionValue(javax.xml.namespace.QName name, XdmSequence value, java.lang.String baseURI, com.xml_project.xom.XOMUtilities.NamespaceMap namespaces, SequenceType type)

Method Summary

OptionValue	copy() Creates a new option object as verbatim copy.
java.net.URI	getAbsoluteURIValue(com.xml_project.morganaxproc.core.steptypes.Step step, boolean required)
java.lang.String	getBaseURI()
java.lang.Boolean	getBooleanValue(com.xml_project.morganaxproc.core.steptypes.Step step, boolean required)
java.lang.Integer	getIntegerValue(com.xml_project.morganaxproc.core.steptypes.Step step, boolean required)
javax.xml.namespace.QName	getName() Returns the options name.
com.xml_project.xom.XOMUtilities.NamespaceMap	getNamespaces() Returns the namespace declarations associated with this option
java.lang.String	getStringValue() Returns the option's value as String or null, if no value is known for the option.
SequenceType	getType() Returns the option's type (per xdm).
XdmSequence	getValue() Returns the option's value or null, if no value is known for the option.
boolean	isOuterSet() Returns true, if this option is set from outside of XProcEngine

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionValue

public OptionValue(javax.xml.namespace.QName name,
                   java.lang.String baseURI,
                   com.xml_project.xom.XOMUtilities.NamespaceMap namespaces,
                   SequenceType type)

Creates a new option value. Option values are created by the XProcEngine.

Parameters:

name -

baseURI -

namespaces -

OptionValue

public OptionValue(javax.xml.namespace.QName name,
                   XdmSequence value,
                   java.lang.String baseURI,
                   com.xml_project.xom.XOMUtilities.NamespaceMap namespaces,
                   SequenceType type)

Parameters:

name -

value -

baseURI -

namespaces -

type -

OptionValue

public OptionValue(javax.xml.namespace.QName name,
                   boolean outer,
                   XdmSequence value,
                   java.lang.String baseURI,
                   com.xml_project.xom.XOMUtilities.NamespaceMap namespaces,
                   SequenceType type)

Creates a new option value. Option values are created by the XProcEngine.

Parameters:

name -

outer -

value -

baseURI -

namespaces -

Method Detail

getType

public SequenceType getType()

Returns the option's type (per xdm).

Returns:

the option's type.

isOuterSet

public boolean isOuterSet()

Returns true, if this option is set from outside of XProcEngine

Returns:

true or false

getValue

public XdmSequence getValue()

Returns the option's value or null, if no value is known for the option.

Returns:

the option's value or null, if no value is known.

getStringValue

public java.lang.String getStringValue()

Returns the option's value as String or null, if no value is known for the option.

Returns:

the option's value or null, if no value is known.

getBooleanValue

public java.lang.Boolean getBooleanValue(com.xml_project.morganaxproc.core.steptypes.Step step,
                                         boolean required)
                                  throws com.xml_project.morganaxproc.core.XProcRuntimeException

Parameters:

step -

required -

Returns:

the options value or null

Throws:

com.xml_project.morganaxproc.core.XProcRuntimeException

getBaseURI

public java.lang.String getBaseURI()

Returns:

the baseURI of p:with-option or null.

getAbsoluteURIValue

public java.net.URI getAbsoluteURIValue(com.xml_project.morganaxproc.core.steptypes.Step step,
                                        boolean required)
                                 throws com.xml_project.morganaxproc.core.XProcRuntimeException

Parameters:

step -

Returns:

the options value or null

Throws:

com.xml_project.morganaxproc.core.XProcRuntimeException

getIntegerValue

public java.lang.Integer getIntegerValue(com.xml_project.morganaxproc.core.steptypes.Step step,
                                         boolean required)
                                  throws com.xml_project.morganaxproc.core.XProcRuntimeException

Parameters:

step -

required -

Returns:

the options value or null

Throws:

com.xml_project.morganaxproc.core.XProcRuntimeException

getName

public javax.xml.namespace.QName getName()

Returns the options name.

Returns:

the options name.

getNamespaces

public com.xml_project.xom.XOMUtilities.NamespaceMap getNamespaces()

Returns the namespace declarations associated with this option

Returns:

the namespace declaration associated with this option

copy

public OptionValue copy()

Creates a new option object as verbatim copy.

Returns:

a new option object.