A B C D E F G I L M P R S T U V W

A

appIndicator - Variable in class uk.co.weft.iso8211.Leader

the application indicator (DDR only) TODO: should this be boolean?

B

baseAddress - Variable in class uk.co.weft.iso8211.Leader

offset (?) to the start of fields

Binary - class uk.co.weft.iso8211.values.Binary.

a binary string.

Binary() - Constructor for class uk.co.weft.iso8211.values.Binary

BitString - class uk.co.weft.iso8211.values.BitString.

don't really know what a bitstring is!

BitString() - Constructor for class uk.co.weft.iso8211.values.BitString

C

CharData - class uk.co.weft.iso8211.values.CharData.

a character data value - fundamentally a string

CharData() - Constructor for class uk.co.weft.iso8211.values.CharData

CharMode - class uk.co.weft.iso8211.values.CharMode.

a character mode bit strong data value - don't really know what this is so we'll treat it for now as if it was a String

CharMode() - Constructor for class uk.co.weft.iso8211.values.CharMode

D

DATA_ID - Static variable in class uk.co.weft.iso8211.ISO8211

(?) 'D' is a valid ID but I don't yet know what it signifies; 'DATA' is a guess

DDR - class uk.co.weft.iso8211.DDR.

The ISO 8211 data definition record.

DDR_ID - Static variable in class uk.co.weft.iso8211.ISO8211

ID code for the DDR leader

DDR(ISO8211InputStream, boolean) - Constructor for class uk.co.weft.iso8211.DDR

create and return a DDR object by reading from the current point in this stream

DDRField - class uk.co.weft.iso8211.DDRField.

A field in an ISO8211 record.

DDRField(ISO8211InputStream, Record, int, boolean) - Constructor for class uk.co.weft.iso8211.DDRField

/** create and return a Field object by reading from the current point in this stream

debug - Variable in class uk.co.weft.iso8211.Value

whether or not we're in debug mode

debug - Variable in class uk.co.weft.iso8211.Parser

whether or not I'm in debug mode

delimiter - Variable in class uk.co.weft.iso8211.Value

my delimiter if not fixed width else -1

description - Variable in class uk.co.weft.iso8211.DDRField

my description

dictionary - Variable in class uk.co.weft.iso8211.DDR

my dictionary: all the record types I've been told about and what's in them.

Dictionary - class uk.co.weft.iso8211.Dictionary.

The dictionary of an ISO 8211 data description record.

Dictionary(ISO8211InputStream, Record, Record, boolean) - Constructor for class uk.co.weft.iso8211.Dictionary

Create a new dictionary by parsing from the current position in this stream.

directory - Variable in class uk.co.weft.iso8211.Record

my directory

Directory - class uk.co.weft.iso8211.Directory.

The directory of an ISO 8211 record.

Directory(ISO8211InputStream, Record, Record, boolean) - Constructor for class uk.co.weft.iso8211.Directory

Create a new directory by parsing from the current position in this stream.

E

ENDMARK - Static variable in class uk.co.weft.iso8211.ISO8211

circumflex - apparently used as an eof marker (?)

eof() - Method in class uk.co.weft.iso8211.ISO8211InputStream

check if this stream is at an end

ESCAPE - Static variable in class uk.co.weft.iso8211.ISO8211

escape

ExplicitPoint - class uk.co.weft.iso8211.values.ExplicitPoint.

a digit string where the decimal point position is explicit.

ExplicitPoint() - Constructor for class uk.co.weft.iso8211.values.ExplicitPoint

extendedCharSet - Variable in class uk.co.weft.iso8211.Leader

the extended character set indicator (DDR only) TODO: should this be boolean?

F

Field - class uk.co.weft.iso8211.Field.

A field (not a DDR field, see separate class DDRField) in an ISO8211 record.

FIELD_TERMINATOR - Static variable in class uk.co.weft.iso8211.ISO8211

the field terminator charactor

Field() - Constructor for class uk.co.weft.iso8211.Field

An empty constructer so that DDRField can do it's own thing.

Field(ISO8211InputStream, Record, int, DDR, boolean) - Constructor for class uk.co.weft.iso8211.Field

create and return a Field object by reading from the current point in this stream

fieldControlLength - Variable in class uk.co.weft.iso8211.Leader

the field control length (?) (DDR only)

fieldLengthSz - Variable in class uk.co.weft.iso8211.Leader

The size of the length of each field

fieldPositionSz - Variable in class uk.co.weft.iso8211.Leader

The size of the position of each field

fields - Variable in class uk.co.weft.iso8211.Record

my fields

fieldTagSz - Variable in class uk.co.weft.iso8211.Leader

The size of the tag of each field

FormatException - exception uk.co.weft.iso8211.FormatException.

An exception thrown when data found violates our expectations of ISO8211 format.

FormatException(String) - Constructor for class uk.co.weft.iso8211.FormatException

G

generate(Context) - Method in class uk.co.weft.iso8211.Parser

Parse an S57 file and generate a document.

generate(Document, Context) - Method in class uk.co.weft.iso8211.Record

Generate XML element representing this record.

generate(Document, Context) - Method in class uk.co.weft.iso8211.SubField

Generate XML element representing this subfield.

generate(Document, Context) - Method in class uk.co.weft.iso8211.Field

Generate XML element representing this field.

getLength(int) - Method in class uk.co.weft.iso8211.Directory

Get the length of my indexth entry.

getPosition() - Method in class uk.co.weft.iso8211.ISO8211InputStream

return the current position in the stream

getPosition(int) - Method in class uk.co.weft.iso8211.Directory

Get the offset of my indexth entry.

getTag(int) - Method in class uk.co.weft.iso8211.Directory

getTransformURL(Context) - Method in class uk.co.weft.iso8211.Parser

get the URL of my stylesheet as a String.

go(long) - Method in class uk.co.weft.iso8211.ISO8211InputStream

go to this position in the stream.

I

id - Variable in class uk.co.weft.iso8211.Leader

my leader ID -- effectively the record type.

imaginary - Variable in class uk.co.weft.iso8211.values.Binary

if it turns out I'm a complex number, my imaginary part

ImplicitPoint - class uk.co.weft.iso8211.values.ImplicitPoint.

a digit string where the decimal point position is implicit.

ImplicitPoint() - Constructor for class uk.co.weft.iso8211.values.ImplicitPoint

index - Variable in class uk.co.weft.iso8211.Field

which field I am within my record

init(Context) - Method in class uk.co.weft.iso8211.Parser

Initialise this generator with configuration information from this context

initialise(int, int, int, boolean) - Method in class uk.co.weft.iso8211.Value

You can't use a constructor for a value because we don't know what class it is when we create it so we have to use Class.newInstance(); consequently, to initialise it we need an initialiser.

inlineCodeExt - Variable in class uk.co.weft.iso8211.Leader

the inline code extension indicator.

interchangeLevel - Variable in class uk.co.weft.iso8211.Leader

the 'interchange level' (DDR only)

interpretFormat(String, StringTokenizer, boolean) - Method in class uk.co.weft.iso8211.DDRField

interpret the format string in a DDR subfield.

interpretHeader() - Method in class uk.co.weft.iso8211.Leader

assuming I'm not a DDR record, interpret my raw header

intValue - Variable in class uk.co.weft.iso8211.values.Binary

if it turns out I'm an integer, my value as an integer

ISO8211 - class uk.co.weft.iso8211.ISO8211.

various constants and primitives for manipulating ISO8211 data, all static

ISO8211() - Constructor for class uk.co.weft.iso8211.ISO8211

ISO8211Exception - exception uk.co.weft.iso8211.ISO8211Exception.

An abstract superclass to group all exceptions generated whilst parsing ISO8211 data.

ISO8211Exception(String) - Constructor for class uk.co.weft.iso8211.ISO8211Exception

ISO8211Exception(String, int) - Constructor for class uk.co.weft.iso8211.ISO8211Exception

ISO8211InputStream - class uk.co.weft.iso8211.ISO8211InputStream.

Lots of stuff in parsing ISO8211 depends on knowing positions and offsets within the stream, but this is generally not easy with Java streams.

ISO8211InputStream(InputStream) - Constructor for class uk.co.weft.iso8211.ISO8211InputStream

constructor.

isValidRecordName(Object) - Static method in class uk.co.weft.iso8211.ISO8211

L

leader - Variable in class uk.co.weft.iso8211.Record

my leader

Leader - class uk.co.weft.iso8211.Leader.

The leader of an ISO 8211 record.

Leader(ISO8211InputStream, Record, Record, boolean) - Constructor for class uk.co.weft.iso8211.Leader

create and return a Leader object by reading from the current point in this stream

length - Variable in class uk.co.weft.iso8211.Leader

the length of the record in which I occur

LostThePlotException - exception uk.co.weft.iso8211.LostThePlotException.

An exception thrown when data found violates our expectations of ISO8211 format, and we suspect it's the parser that's wrong.

LostThePlotException(String) - Constructor for class uk.co.weft.iso8211.LostThePlotException

LSOFBinary - class uk.co.weft.iso8211.values.LSOFBinary.

a binary string, sent least significant byte first.

LSOFBinary() - Constructor for class uk.co.weft.iso8211.values.LSOFBinary

M

main(String[]) - Static method in class uk.co.weft.iso8211.Parser

very crude command line shell.

MSOFBinary - class uk.co.weft.iso8211.values.MSOFBinary.

a binary string, sent most significant byte first.

MSOFBinary() - Constructor for class uk.co.weft.iso8211.values.MSOFBinary

P

Parser - class uk.co.weft.iso8211.Parser.

Command line for ISO 8211 parse.

Parser() - Constructor for class uk.co.weft.iso8211.Parser

peek() - Method in class uk.co.weft.iso8211.ISO8211InputStream

peek at the next byte on the stream but don't remove it.

position - Variable in class uk.co.weft.iso8211.Leader

the position at which I was found in the input stream

position - Variable in class uk.co.weft.iso8211.Directory

the position at which I was found in the input stream

position - Variable in class uk.co.weft.iso8211.Dictionary

the position at which I was found in the input stream

precision - Variable in class uk.co.weft.iso8211.Value

how many bytes I occupy if fixed width else -1

R

read() - Method in class uk.co.weft.iso8211.ISO8211InputStream

read the next byte from the stream and increment the counter

read(byte[], int, int) - Method in class uk.co.weft.iso8211.ISO8211InputStream

read the next few bytes from the stream into this array.

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.Reader

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.Value

Specialise this! Dummy does nothing except skip the right number of places on the stream to check we're still in sync

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.values.ScaledPoint

Read my value from the stream

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.values.LSOFBinary

Handle each of my subtypes

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.values.CharData

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.values.ImplicitPoint

Read my value from the stream

read(ISO8211InputStream) - Method in class uk.co.weft.iso8211.values.ExplicitPoint

Reader - class uk.co.weft.iso8211.Reader.

A reader which can read one kind of value from the stream.

Reader(String, String, int, int, int, boolean) - Constructor for class uk.co.weft.iso8211.Reader

create a new reader for a datum of this type

readers - Variable in class uk.co.weft.iso8211.DDRField

my subfields

readInt() - Method in class uk.co.weft.iso8211.ISO8211InputStream

read an ASCII formatted integer value from this stream

readRecord(ISO8211InputStream, DDR) - Method in class uk.co.weft.iso8211.Parser

get the next record from my stream if any

readString() - Method in class uk.co.weft.iso8211.ISO8211InputStream

read a string of data up to but not including a unit terminator.

readString(int) - Method in class uk.co.weft.iso8211.ISO8211InputStream

read a string of data up to but not including this terminator character.

readString(int, int) - Method in class uk.co.weft.iso8211.ISO8211InputStream

read a string from the stream with either delimiter or precision.

readStringWithPrecision(int) - Method in class uk.co.weft.iso8211.ISO8211InputStream

read this many characters from the stream and return them as a string

realValue - Variable in class uk.co.weft.iso8211.values.Binary

if it turns out I'm a real, my value as a (real) double

REC_ID - Static variable in class uk.co.weft.iso8211.ISO8211

(?) 'R' is a valid ID but I don't yet know what it signifies; 'REC' is a guess

record - Variable in class uk.co.weft.iso8211.Record

record - Variable in class uk.co.weft.iso8211.Directory

the record I am in

record - Variable in class uk.co.weft.iso8211.Field

the record of which this field forms part

Record - class uk.co.weft.iso8211.Record.

An ISO 8211 record

Record() - Constructor for class uk.co.weft.iso8211.Record

An empty constructur so that DDR can do it's own thing.

Record(ISO8211InputStream, DDR, boolean) - Constructor for class uk.co.weft.iso8211.Record

create and return a Record object by reading from the current point in this stream

S

ScaledPoint - class uk.co.weft.iso8211.values.ScaledPoint.

a digit string where the decimal point position is scaled.

ScaledPoint() - Constructor for class uk.co.weft.iso8211.values.ScaledPoint

skip(long) - Method in class uk.co.weft.iso8211.ISO8211InputStream

skip over (discard) this many bytes in the stream.

SPACE - Static variable in class uk.co.weft.iso8211.ISO8211

space

SubField - class uk.co.weft.iso8211.SubField.

A subfield within an ISO8211 field.

SubField(String, Value) - Constructor for class uk.co.weft.iso8211.SubField

subfields - Variable in class uk.co.weft.iso8211.Field

my subfields

subtype - Variable in class uk.co.weft.iso8211.Value

my subtype if relevent else -1

SUBTYPE_COMPLEX - Static variable in class uk.co.weft.iso8211.ISO8211

SUBTYPE_COMPLEX_FLOAT - Static variable in class uk.co.weft.iso8211.values.Binary

SUBTYPE_FIXED_POINT - Static variable in class uk.co.weft.iso8211.ISO8211

SUBTYPE_FLOAT_POINT - Static variable in class uk.co.weft.iso8211.ISO8211

SUBTYPE_INVALID - Static variable in class uk.co.weft.iso8211.ISO8211

this one isn't in the ISO 8211 spec but serves as a marker that we haven't found a valid value

SUBTYPE_REAL_FIXED - Static variable in class uk.co.weft.iso8211.values.Binary

SUBTYPE_REAL_FLOAT - Static variable in class uk.co.weft.iso8211.values.Binary

SUBTYPE_SIGNED_INT - Static variable in class uk.co.weft.iso8211.ISO8211

SUBTYPE_SIGNED_INT - Static variable in class uk.co.weft.iso8211.values.Binary

SUBTYPE_UNSIGNED_INT - Static variable in class uk.co.weft.iso8211.ISO8211

binary data sub-types

SUBTYPE_UNSIGNED_INT - Static variable in class uk.co.weft.iso8211.values.Binary

what the subtypes actually mean

T

tag - Variable in class uk.co.weft.iso8211.Field

my field name

toString() - Method in class uk.co.weft.iso8211.Value

yes, I know anything can be rendered as a string, but a value explicitly can.

toString() - Method in class uk.co.weft.iso8211.values.Binary

Stringify the thing I really am

toString() - Method in class uk.co.weft.iso8211.values.ScaledPoint

toString() - Method in class uk.co.weft.iso8211.values.BitString

toString() - Method in class uk.co.weft.iso8211.values.CharData

toString() - Method in class uk.co.weft.iso8211.values.ImplicitPoint

toString() - Method in class uk.co.weft.iso8211.values.ExplicitPoint

toString() - Method in class uk.co.weft.iso8211.values.CharMode

transformURL - Variable in class uk.co.weft.iso8211.Parser

the URL to use to transform the output

U

uk.co.weft.iso8211 - package uk.co.weft.iso8211

A package to parse ISO8211 data and return a DOM tree.

uk.co.weft.iso8211.values - package uk.co.weft.iso8211.values

Values which may be found in an ISO8211 file.

UnexpectedEndException - exception uk.co.weft.iso8211.UnexpectedEndException.

An exception thrown when we reach the end of an ISO8211 stream unexpectedly

UnexpectedEndException(String) - Constructor for class uk.co.weft.iso8211.UnexpectedEndException

UNIT_TERMINATOR - Static variable in class uk.co.weft.iso8211.ISO8211

unit terminator charactor

unread(byte[]) - Method in class uk.co.weft.iso8211.ISO8211InputStream

push these bytes back onto the stream

unread(byte[], int, int) - Method in class uk.co.weft.iso8211.ISO8211InputStream

push these bytes back onto the stream

unread(int) - Method in class uk.co.weft.iso8211.ISO8211InputStream

push this byte back onto the stream

V

V0 - Static variable in class uk.co.weft.iso8211.ISO8211

V1 - Static variable in class uk.co.weft.iso8211.ISO8211

Value - class uk.co.weft.iso8211.Value.

Abstract superclass for a subfield value; real classes which implement values are in the package uk.co.weft.iso8211.values

Value() - Constructor for class uk.co.weft.iso8211.Value

version - Variable in class uk.co.weft.iso8211.Leader

the ISO8211 version `number' (DDR only)

W

whinge(Exception, long) - Static method in class uk.co.weft.iso8211.ISO8211

Print as much detail as possible about this error on the stadard error stream.

A B C D E F G I L M P R S T U V W