Module io.xlate.staedi

Package io.xlate.edi.internal.stream

Class LocationView

java.lang.Object

io.xlate.edi.internal.stream.LocationView

All Implemented Interfaces:

Location

Direct Known Subclasses:

StaEDIStreamLocation

public class LocationView
extends Object
implements Location

Field Summary

Fields

Modifier and Type	Field	Description
protected int	characterOffset
protected int	columnNumber
protected int	componentPosition
protected int	elementOccurrence
protected int	elementPosition
protected int	lineNumber
protected int	segmentPosition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocationView()
	LocationView(Location source)

Method Summary

Modifier and Type	Method	Description
int	getCharacterOffset()	Return the byte or character offset into the input source this location is pointing to.
int	getColumnNumber()	Return the column number where the current event ends, returns -1 if none is available.
int	getComponentPosition()	Return the component data element position within the current composite data element, returns -1 if none is available.
int	getElementOccurrence()	Return the current occurrence number of a repeating data element, returns 1 for non-repeating elements and -1 if otherwise not available.
int	getElementPosition()	Return the element position within the current segment, returns -1 if none is available.
int	getLineNumber()	Return the line number where the current event ends, returns -1 if none is available.
int	getSegmentPosition()	Return the segment position within the current stream, returns -1 if none is available.

Methods inherited from class java.lang.Object

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

Field Detail

lineNumber

protected int lineNumber

columnNumber

protected int columnNumber

characterOffset

protected int characterOffset

segmentPosition

protected int segmentPosition

elementPosition

protected int elementPosition

componentPosition

protected int componentPosition

elementOccurrence

protected int elementOccurrence

Constructor Detail

LocationView

public LocationView(Location source)

LocationView

protected LocationView()

Method Detail

getLineNumber

public int getLineNumber()

Description copied from interface: Location

Return the line number where the current event ends, returns -1 if none is available.

Specified by:

getLineNumber in interface Location

Returns:

the current line number

getColumnNumber

public int getColumnNumber()

Description copied from interface: Location

Return the column number where the current event ends, returns -1 if none is available.

Specified by:

getColumnNumber in interface Location

Returns:

the current column number

getCharacterOffset

public int getCharacterOffset()

Description copied from interface: Location

Return the byte or character offset into the input source this location is pointing to. If the input source is a file or a byte stream then this is the byte offset into that stream, but if the input source is a character media then the offset is the character offset. Returns -1 if there is no offset available.

Specified by:

getCharacterOffset in interface Location

Returns:

the current offset

getSegmentPosition

public int getSegmentPosition()

Description copied from interface: Location

Return the segment position within the current stream, returns -1 if none is available.

Specified by:

getSegmentPosition in interface Location

Returns:

the current segment position

getElementPosition

public int getElementPosition()

Description copied from interface: Location

Return the element position within the current segment, returns -1 if none is available.

Specified by:

getElementPosition in interface Location

Returns:

the current element position

getComponentPosition

public int getComponentPosition()

Description copied from interface: Location

Return the component data element position within the current composite data element, returns -1 if none is available.

Specified by:

getComponentPosition in interface Location

Returns:

the current component element position

getElementOccurrence

public int getElementOccurrence()

Description copied from interface: Location

Return the current occurrence number of a repeating data element, returns 1 for non-repeating elements and -1 if otherwise not available.

Specified by:

getElementOccurrence in interface Location

Returns:

the current element occurrence