org.apache.daffodil.japi.infoset

Class InfosetInputter

java.lang.Object

org.apache.daffodil.runtime1.infoset.InfosetInputter

org.apache.daffodil.japi.infoset.InfosetInputter

All Implemented Interfaces:

org.apache.daffodil.lib.util.Cursor<org.apache.daffodil.runtime1.infoset.InfosetAccessor>, org.apache.daffodil.lib.util.CursorImplMixin<org.apache.daffodil.runtime1.infoset.InfosetAccessor>, org.apache.daffodil.runtime1.infoset.NextElementResolver

Direct Known Subclasses:

InfosetInputterProxy

public abstract class InfosetInputter
extends org.apache.daffodil.runtime1.infoset.InfosetInputter

Abstract class used to determine how the infoset representation should be input from a call to DataProcessor#unparse. This uses a Cursor API, such that each call to advance/inspect must update a cursor value, minimizing allocations. Callers of advance/inspect are expected to copy out any information from advanceAccessor and inspectAccessor if they need to retain the information after a call to advance/inspect.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.daffodil.lib.util.CursorImplMixin

org.apache.daffodil.lib.util.CursorImplMixin.Advance$, org.apache.daffodil.lib.util.CursorImplMixin.Inspect$, org.apache.daffodil.lib.util.CursorImplMixin.OpKind, org.apache.daffodil.lib.util.CursorImplMixin.Unsuccessful$

Constructor Summary

Constructors

Constructor and Description
InfosetInputter()

Method Summary

Modifier and Type	Method and Description
abstract org.apache.daffodil.runtime1.infoset.InfosetInputterEventType	getEventType() Return the current infoset inputter event type
abstract java.lang.String	getLocalName() Get the local name of the current event.
abstract java.lang.String	getNamespaceURI() Get the namespace of the current event.
abstract java.lang.String	getSimpleText(org.apache.daffodil.runtime1.dpath.NodeInfo.Kind primType) See getSimpleText(primType, runtimeProperties), which has a default implementation to call this function without the runtimeProperties Map
java.lang.String	getSimpleText(org.apache.daffodil.runtime1.dpath.NodeInfo.Kind primType, java.util.Map<java.lang.String,java.lang.String> runtimeProperties) Get the content of a simple type.
abstract boolean	hasNext() Return true if there are remaining events.
abstract org.apache.daffodil.lib.util.MaybeBoolean	isNilled() Determine if the current event is nilled.
abstract void	next() Move the internal state to the next event.

Methods inherited from class org.apache.daffodil.runtime1.infoset.InfosetInputter

accessor_$eq, accessor, advance, Advance, advanceAccessor, advanceMaybe, documentElement, fill, initialize, inspect, Inspect, inspectAccessor, inspectMaybe, isInitialized, maybeTopTRD, nextElement, org$apache$daffodil$lib$util$CursorImplMixin$$isFilled_$eq, org$apache$daffodil$lib$util$CursorImplMixin$$isFilled, org$apache$daffodil$runtime1$infoset$NextElementResolver$_setter_$org$apache$daffodil$runtime1$infoset$NextElementResolver$$trdStack_$eq, org$apache$daffodil$runtime1$infoset$NextElementResolver$$trdStack, popTRD, priorOpKind_$eq, priorOpKind, pushTRD, supportsNamespaces, toString, tunable_$eq, tunable, Unsuccessful

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.daffodil.lib.util.CursorImplMixin

$init$

Methods inherited from interface org.apache.daffodil.lib.util.Cursor

$init$, fini

Methods inherited from interface org.apache.daffodil.runtime1.infoset.NextElementResolver

$init$

Constructor Detail

InfosetInputter

public InfosetInputter()

Method Detail

getEventType

public abstract org.apache.daffodil.runtime1.infoset.InfosetInputterEventType getEventType()

Return the current infoset inputter event type

Specified by:

getEventType in class org.apache.daffodil.runtime1.infoset.InfosetInputter

Returns:

(undocumented)

getLocalName

public abstract java.lang.String getLocalName()

Get the local name of the current event. This will only be called when the current event type is StartElement.

Specified by:

getLocalName in class org.apache.daffodil.runtime1.infoset.InfosetInputter

Returns:

(undocumented)

getNamespaceURI

public abstract java.lang.String getNamespaceURI()

Get the namespace of the current event. This will only be called when the current event type is StartElement. If the InfosetInputter does not support namespaces, this shoud return null. This may return null to represent no namespaces.

Specified by:

getNamespaceURI in class org.apache.daffodil.runtime1.infoset.InfosetInputter

Returns:

(undocumented)

getSimpleText

public java.lang.String getSimpleText(org.apache.daffodil.runtime1.dpath.NodeInfo.Kind primType,
                                      java.util.Map<java.lang.String,java.lang.String> runtimeProperties)

Get the content of a simple type. This will only be called when the current event type is StartElement and the element is a simple type. If the event contains complex data, it is an error and should throw NonTextFoundInSimpleContentException. If the element does not have any simple content, this should return either null or the empty string.

Specified by:

getSimpleText in class org.apache.daffodil.runtime1.infoset.InfosetInputter

Parameters:

primType - (undocumented)

runtimeProperties - (undocumented)

Returns:

(undocumented)

getSimpleText

public abstract java.lang.String getSimpleText(org.apache.daffodil.runtime1.dpath.NodeInfo.Kind primType)

See getSimpleText(primType, runtimeProperties), which has a default implementation to call this function without the runtimeProperties Map

Parameters:

primType - (undocumented)

Returns:

(undocumented)

hasNext

public abstract boolean hasNext()

Return true if there are remaining events. False otherwise.

Specified by:

hasNext in class org.apache.daffodil.runtime1.infoset.InfosetInputter

Returns:

(undocumented)

isNilled

public abstract org.apache.daffodil.lib.util.MaybeBoolean isNilled()

Determine if the current event is nilled. This will only be called when the current event type is StartElement. Return MaybeBoolean.Nope if no nil property is set, which implies the element is not nilled. Return MaybeBoolean(false) if the nil property is set, but it is set to false. Return MaybeBoolean(true) if the nil property is set to true.

Returns:

(undocumented)

next

public abstract void next()

Move the internal state to the next event.

Specified by:

next in class org.apache.daffodil.runtime1.infoset.InfosetInputter