org.apache.daffodil.japi

Class ProcessorFactory

java.lang.Object

org.apache.daffodil.japi.WithDiagnostics

org.apache.daffodil.japi.ProcessorFactory

All Implemented Interfaces:

java.io.Serializable

public class ProcessorFactory
extends WithDiagnostics

Factory to create DataProcessor's, used for parsing data

Do not use the ProcessorFactry constructor to create a ProcessorFactory. Instead, use Compiler.compileFile(java.io.File)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ProcessorFactory.ExperimentalWrapper Wrapper class used to mimic a Scala object namespacing experimental APIs

Constructor Summary

Constructors

Constructor and Description
ProcessorFactory(org.apache.daffodil.compiler.ProcessorFactory pf)

Method Summary

Modifier and Type	Method and Description
ProcessorFactory.ExperimentalWrapper	experimental()
DataProcessor	onPath(java.lang.String path) Create a DataProcessor
void	setDistinguishedRootNode(java.lang.String name, java.lang.String namespace) Deprecated. Use withDistinguishedRootNode. Since 2.6.0.
ProcessorFactory	withDistinguishedRootNode(java.lang.String name, java.lang.String namespace) Get a new ProcessorFactory having a global element specified as the root of DFDL Schema to start parsing.

Methods inherited from class org.apache.daffodil.japi.WithDiagnostics

canProceed, getDiagnostics, isError

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessorFactory

public ProcessorFactory(org.apache.daffodil.compiler.ProcessorFactory pf)

Method Detail

experimental

public ProcessorFactory.ExperimentalWrapper experimental()

onPath

public DataProcessor onPath(java.lang.String path)

Create a DataProcessor

Parameters:

path - path to an element to use as the parsing root, relative to the distinguished root node. Currently, must be set to "/"

Returns:

DataProcessor used to parse data. Must check WithDiagnostics.isError() before using it.

setDistinguishedRootNode

public void setDistinguishedRootNode(java.lang.String name,
                                     java.lang.String namespace)

Deprecated. Use withDistinguishedRootNode. Since 2.6.0.

Specify a global element to be the root of DFDL Schema to start parsing

Parameters:

name - name of the root node

namespace - namespace of the root node. Set to empty string to specify no namespace. Set to to NULL to figure out the namespace.

withDistinguishedRootNode

public ProcessorFactory withDistinguishedRootNode(java.lang.String name,
                                                  java.lang.String namespace)

Get a new ProcessorFactory having a global element specified as the root of DFDL Schema to start parsing.

Parameters:

name - name of the root node

namespace - namespace of the root node. Set to empty string to specify no namespace. Set to to NULL to figure out the namespace.

Returns:

(undocumented)