org.openexi.proc.common
Interface EventDescription

All Known Implementing Classes:

EventType

public interface EventDescription

EventDescription provides accessors to the current EXI event data during the decode process.

Note that the content of EventDescription is transient, which means its content may change when the decoder is asked for access to the next EXI event data.

Field Summary

static byte	EVENT_AT Attribute event.
static byte	EVENT_BLOB BLOB event (content of an element).
static byte	EVENT_CH Character event (content of an element).
static byte	EVENT_CM Comment event.
static byte	EVENT_DTD Document Type Definition event.
static byte	EVENT_ED End Document event.
static byte	EVENT_EE End Element event.
static byte	EVENT_ER Entity Reference event.
static byte	EVENT_NL Attribute xsi:nil.
static byte	EVENT_NS Namespace declaration event.
static byte	EVENT_PI Processing Instruction event.
static byte	EVENT_SD Start Document event.
static byte	EVENT_SE Start Element event.
static byte	EVENT_TP Attribute xsi:type.

Method Summary

BinaryDataSource	getBinaryDataSource() Gets the value of an EVENT_BLOB.
Characters	getCharacters() Gets the value of an EVENT_CH, Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM, EVENT_DTD or EVENT_PI event.
byte	getEventKind() Gets the event kind of which instance data this EventDescription is describing.
EventType	getEventType() Returns the EventType from which this event is derived.
java.lang.String	getName() Gets the name of the EXI event.
java.lang.String	getPrefix() Gets the namespace prefix of the event.
java.lang.String	getURI() Gets the URI of the EXI event.

Field Detail

EVENT_SD

static final byte EVENT_SD

Start Document event.

See Also:

Constant Field Values

EVENT_ED

static final byte EVENT_ED

End Document event.

See Also:

Constant Field Values

EVENT_SE

static final byte EVENT_SE

Start Element event.

See Also:

Constant Field Values

EVENT_AT

static final byte EVENT_AT

Attribute event.

See Also:

Constant Field Values

EVENT_TP

static final byte EVENT_TP

Attribute xsi:type.

See Also:

Constant Field Values

EVENT_NL

static final byte EVENT_NL

Attribute xsi:nil.

See Also:

Constant Field Values

EVENT_CH

static final byte EVENT_CH

Character event (content of an element).

See Also:

Constant Field Values

EVENT_EE

static final byte EVENT_EE

End Element event.

See Also:

Constant Field Values

EVENT_NS

static final byte EVENT_NS

Namespace declaration event.

See Also:

Constant Field Values

EVENT_PI

static final byte EVENT_PI

Processing Instruction event.

See Also:

Constant Field Values

EVENT_CM

static final byte EVENT_CM

Comment event.

See Also:

Constant Field Values

EVENT_ER

static final byte EVENT_ER

Entity Reference event.

See Also:

Constant Field Values

EVENT_DTD

static final byte EVENT_DTD

Document Type Definition event.

See Also:

Constant Field Values

EVENT_BLOB

static final byte EVENT_BLOB

BLOB event (content of an element).

See Also:

Constant Field Values

Method Detail

getEventKind

byte getEventKind()

Gets the event kind of which instance data this EventDescription is describing.

Returns:

a byte representing the event kind.

getURI

java.lang.String getURI()

Gets the URI of the EXI event.

Returns:

the URI as a String.

getName

java.lang.String getName()

Gets the name of the EXI event.

Returns:

the name of the event as a String.

getPrefix

java.lang.String getPrefix()

Gets the namespace prefix of the event.

Returns:

the prefix as a String.

getCharacters

Characters getCharacters()

Gets the value of an EVENT_CH, Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM, EVENT_DTD or EVENT_PI event.

Returns:

a Characters of the corresponding value

getBinaryDataSource

BinaryDataSource getBinaryDataSource()

Gets the value of an EVENT_BLOB.

Returns:

a BinaryData of the corresponding value

getEventType

EventType getEventType()

Returns the EventType from which this event is derived.