Index (StAEDI : Streaming API for EDI for Java 1.24.1 API)

A B C D E F G H I J L M N P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(EDIStreamReader) - Method in interface io.xlate.edi.stream.EDIStreamFilter: Tests whether the current state is part of this stream.
all() - Static method in class io.xlate.edi.stream.EDINamespaces: Obtain a list of all namespace constants declared by EDINamespaces.

B

BINARY - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base
buildMessage(String, Location) - Static method in exception io.xlate.edi.stream.EDIStreamException: Build a readable message that includes a detail message together with the location of the exception

C

close() - Method in interface io.xlate.edi.stream.EDIStreamReader: Frees any resources associated with this Reader.
close() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Close this writer and free any resources associated with the writer.
COMPONENT_ELEMENT - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Delimiters: Key for the delimiter used to terminate/end a component of a composite element.
COMPOSITE - Enum constant in enum io.xlate.edi.schema.EDIType.Type
CompositeImplementation - Interface in io.xlate.edi.schema.implementation
COMPOSITES - Static variable in class io.xlate.edi.stream.EDINamespaces: XML namespace used for EDI composite elements - those elements containing sub-elements, i.e.
CONDITIONAL - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: Type C EDIFACT: (D5) If first, then all
CONDITIONAL_REQUIRED_DATA_ELEMENT_MISSING - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is configured as conditionally required (relative to other elements in the segment) in the schema but was not present in the data stream.
CONDITIONAL_REQUIRED_SEGMENT_MISSING - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment is configured as conditionally required (relative to other segments in the loop) in the schema but was not present in the data stream.
containsSegment(String) - Method in interface io.xlate.edi.schema.Schema: Determine if the named segment is present in this schema.
CONTROL_COUNT_DOES_NOT_MATCH_ACTUAL_COUNT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Control count (e.g.
CONTROL_REFERENCE_MISMATCH - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Control number/reference in the trailer segment does not match the value encountered in the header.
CONTROLS - Enum constant in enum io.xlate.edi.schema.EDIControlType.Type: Indicates that the element identified by EDIControlType.getTrailerCountPosition() will contain a count of the control structures internal to the EDIControlType.
copy() - Method in interface io.xlate.edi.stream.Location: Create a new copy of this instance
createEDIStreamReader(InputStream) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new EDIStreamReader using the given InputStream (with default encoding).
createEDIStreamReader(InputStream, Schema) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new EDIStreamReader using the given InputStream (with default encoding) which uses the Schema for validation of the input's control structures (interchange, group, transaction).
createEDIStreamReader(InputStream, String) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new EDIStreamReader using the given InputStream and encoding.
createEDIStreamReader(InputStream, String, Schema) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new EDIStreamReader using the given InputStream and encoding which uses the Schema for validation of the input's control structures (interchange, group, transaction).
createEDIStreamWriter(OutputStream) - Method in class io.xlate.edi.stream.EDIOutputFactory: Create a new EDIStreamWriter that writes to a stream
createEDIStreamWriter(OutputStream, String) - Method in class io.xlate.edi.stream.EDIOutputFactory: Create a new EDIStreamWriter that writes to a stream
createFilteredReader(EDIStreamReader, EDIStreamFilter) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new EDIStreamReader by wrapping the given reader with the EDIStreamFilter filter.
createJsonParser(EDIStreamReader, Class<J>) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new JSON parser of type J that uses the given reader as its data source.
createSchema(InputStream) - Method in interface io.xlate.edi.schema.SchemaFactory
createSchema(URL) - Method in interface io.xlate.edi.schema.SchemaFactory
createXMLStreamReader(EDIStreamReader) - Method in class io.xlate.edi.stream.EDIInputFactory: Creates a new XMLStreamReader that uses the given reader as its data source.
createXMLStreamWriter(EDIStreamWriter) - Method in class io.xlate.edi.stream.EDIOutputFactory: Creates a new XMLStreamWriter that uses the given writer as its output.

D

data - Variable in exception io.xlate.edi.stream.EDIValidationException: The data from the data stream (input for a reader or output for a writer) associated with the validation error.
DATA_ELEMENT - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Delimiters: Key for the delimiter used to terminate/end a simple or composite data element.
DATA_ELEMENT_TOO_LONG - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element length is greater than the maximum length allowed by the configured schema.
DATA_ELEMENT_TOO_SHORT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element length is less than the minimum length required by the configured schema.
DATE - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base
DECIMAL - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base
DECIMAL - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Delimiters: Key for the character used as the decimal point for non-integer numeric element types.
Discriminator - Interface in io.xlate.edi.schema.implementation

E

EDI_ENABLE_LOOP_TEXT - Static variable in class io.xlate.edi.stream.EDIInputFactory: Deprecated.
use getReferenceCode() and getSchemaTypeReference() to retrieve additional information for non-textual event types.
EDI_IGNORE_EXTRANEOUS_CHARACTERS - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, non-graphical, control characters will be ignored in the EDI input stream.
EDI_NEST_HIERARCHICAL_LOOPS - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, hierarchical loops will be nested in the EDI input stream.
EDI_VALIDATE_CONTROL_CODE_VALUES - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to false, enumerated code values of control structure elements will be ignore.
EDI_VALIDATE_CONTROL_STRUCTURE - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to false, control structures, segments, elements, and codes will not be validated unless a user-provided control schema has been set using setControlSchema(Schema).
EDIComplexType - Interface in io.xlate.edi.schema: An interface representing the schema of an EDI complex type such as a loop, segment, or composite element.
EDIControlType - Interface in io.xlate.edi.schema: Provides access to attributes specified for a control structure complex type such as the interchange, group, and transaction envelope structures.
EDIControlType.Type - Enum in io.xlate.edi.schema
EDIElementPosition - Interface in io.xlate.edi.schema: Specification of the position of an element.
EDIFACT - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Standards: Constant name for the EDIFACT EDI Dialect
EDIInputErrorReporter - Interface in io.xlate.edi.stream: This interface is used to report non-fatal errors detected in an EDI input.
EDIInputFactory - Class in io.xlate.edi.stream: Defines an abstract implementation of a factory for getting EDIStreamReaders, JSON parsers (wrapping an existing EDIStreamReader), and XMLStreamReaders (wrapping an existing EDIStreamReader).
EDIInputFactory() - Constructor for class io.xlate.edi.stream.EDIInputFactory: Default constructor
EDILoopType - Interface in io.xlate.edi.schema: Provides access to attributes specified for a loop complex type.
EDINamespaces - Class in io.xlate.edi.stream: Defines the constant values of namespaces for each of the XML elements generated by the XMLStreamReader (created via EDIInputFactory.createXMLStreamReader(EDIStreamReader) and consumed by the XMLStreamWriter (created via EDIOutputFactory.createXMLStreamWriter(EDIStreamWriter).
EDIOutputErrorReporter - Interface in io.xlate.edi.stream: This interface is used to report non-fatal errors detected in an EDI input.
EDIOutputFactory - Class in io.xlate.edi.stream: Defines an abstract implementation of a factory for getting EDIStreamWriters and XMLStreamWriters (wrapping an existing EDIStreamWriter).
EDIOutputFactory() - Constructor for class io.xlate.edi.stream.EDIOutputFactory: Default constructor
EDIReference - Interface in io.xlate.edi.schema
EDIReporter - Interface in io.xlate.edi.stream: Deprecated.
implement EDIInputErrorReporter instead. This interface will be removed in a future version of StAEDI.
EDISchemaException - Exception in io.xlate.edi.schema
EDISchemaException(String) - Constructor for exception io.xlate.edi.schema.EDISchemaException: Construct an exception with the associated message.
EDISchemaException(String, Throwable) - Constructor for exception io.xlate.edi.schema.EDISchemaException: Construct an exception with the associated message and exception
EDISchemaException(String, Location, Throwable) - Constructor for exception io.xlate.edi.schema.EDISchemaException: Construct an exception with the associated message, exception and location.
EDISimpleType - Interface in io.xlate.edi.schema: An interface representing the schema of an EDI simple type, AKA an element.
EDISimpleType.Base - Enum in io.xlate.edi.schema
EDIStreamConstants - Interface in io.xlate.edi.stream: Collection of constant values identifying the several EDI standards and the delimiters used in processing EDI data streams.
EDIStreamConstants.Delimiters - Class in io.xlate.edi.stream: Defines the constant values of EDI delimiters present in the maps returned by getDelimiters()/EDIStreamWriter.getDelimiters() and accepted as properties for output via PropertySupport.setProperty(String, Object).
EDIStreamConstants.Standards - Class in io.xlate.edi.stream: Defines the constant values possibly returned by getStandard() and EDIStreamWriter.getStandard().
EDIStreamEvent - Enum in io.xlate.edi.stream: Enumeration of stream event types that may be encountered by the EDIStreamReader.
EDIStreamException - Exception in io.xlate.edi.stream: Checked exception that may be thrown by EDIInputFactory, EDIStreamReader, EDIOutputFactory, and EDIStreamWriter in the processing of EDI data.
EDIStreamException(String) - Constructor for exception io.xlate.edi.stream.EDIStreamException: Construct an exception with the associated message.
EDIStreamException(String, Location) - Constructor for exception io.xlate.edi.stream.EDIStreamException: Construct an exception with the associated message, exception and location.
EDIStreamException(String, Location, Throwable) - Constructor for exception io.xlate.edi.stream.EDIStreamException: Construct an exception with the associated message, exception and location.
EDIStreamException(Throwable) - Constructor for exception io.xlate.edi.stream.EDIStreamException: Deprecated.
EDIStreamFilter - Interface in io.xlate.edi.stream: This interface declares a simple filter interface that one can create to filter EDIStreamReaders
EDIStreamReader - Interface in io.xlate.edi.stream: The EDIStreamReader interface allows forward, read-only access to EDI.
EDIStreamValidationError - Enum in io.xlate.edi.stream: Enumeration of validation error types that may be encountered by the EDIStreamReader or EDIStreamWriter.
EDIStreamWriter - Interface in io.xlate.edi.stream: The EDIStreamWriter interface specifies how to write EDI.
EDISyntaxRule - Interface in io.xlate.edi.schema
EDISyntaxRule.Type - Enum in io.xlate.edi.schema
EDIType - Interface in io.xlate.edi.schema
EDIType.Type - Enum in io.xlate.edi.schema
EDITypeImplementation - Interface in io.xlate.edi.schema.implementation
EDIValidationException - Exception in io.xlate.edi.stream: Runtime exception that may occur when reading or writing EDI any the EDI error event would not otherwise be handled by an application.
EDIValidationException(EDIStreamEvent, EDIStreamValidationError, Location, CharSequence) - Constructor for exception io.xlate.edi.stream.EDIValidationException: Construct an EDIValidationException with the given data elements.
ELEMENT - Enum constant in enum io.xlate.edi.schema.EDIType.Type
ELEMENT_DATA - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for a simple element or component element (within a composite).
ELEMENT_DATA_BINARY - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for binary element data
ELEMENT_DATA_ERROR - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for an error relating to the data received in an element.
ELEMENT_OCCURRENCE_ERROR - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for an error relating to the an occurrence of an element.
ElementImplementation - Interface in io.xlate.edi.schema.implementation
ELEMENTS - Static variable in class io.xlate.edi.stream.EDINamespaces: XML namespace used for EDI simple elements and the components of a composite element,
END_COMPOSITE - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the end of a composite element.
END_GROUP - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the end of a functional group.
END_INTERCHANGE - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the end of an interchange.
END_LOOP - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the end of a data loop (logical grouping of segments).
END_SEGMENT - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the end of a segment.
END_TRANSACTION - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the end of a transaction.
endComponent() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Complete a component of a composite element.
endElement() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Complete an element.
endInterchange() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Completes an interchange and returns the writer to its initial state.
error - Variable in exception io.xlate.edi.stream.EDIValidationException: The actual error of this exception.
event - Variable in exception io.xlate.edi.stream.EDIValidationException: The stream event associated with the error, one of the events for which EDIStreamEvent.isError() is true.
EXCLUSION - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: Type E EDIFACT: (D4) One or none
EXCLUSION_CONDITION_VIOLATED - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is configured as conditionally excluded (relative to other elements in the segment) in the schema but was present in the data stream.

F

FIRSTONLY - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: N/A EDIFACT: (D7) If first, then none of the others
flush() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write any cached data to the underlying output mechanism.
FORMAT_ELEMENTS - Static variable in class io.xlate.edi.stream.EDIOutputFactory: When set to true and a schema has been provided, elements written to the output will be padded to the minimum length required by the schema.
fromString(String) - Static method in enum io.xlate.edi.schema.EDIControlType.Type
fromString(String) - Static method in enum io.xlate.edi.schema.EDISimpleType.Base
fromString(String) - Static method in enum io.xlate.edi.schema.EDISyntaxRule.Type

G

getBase() - Method in interface io.xlate.edi.schema.EDISimpleType
getBinaryData() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns an InputStream for reading the binary element data for the current element.
getCategory() - Method in enum io.xlate.edi.stream.EDIStreamValidationError: Provides the category of the validation error.
getCharacterOffset() - Method in interface io.xlate.edi.stream.Location: Return the byte or character offset into the input source this location is pointing to.
getCode() - Method in interface io.xlate.edi.schema.EDIType
getColumnNumber() - Method in interface io.xlate.edi.stream.Location: Return the column number where the current event ends, returns -1 if none is available.
getComponentPosition() - Method in interface io.xlate.edi.schema.EDIElementPosition: Get the component position within a composite element.
getComponentPosition() - Method in interface io.xlate.edi.stream.Location: Return the component data element position within the current composite data element, returns -1 if none is available.
getControlSchema() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns the control schema currently set on the reader.
getControlSchema() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Returns the control schema currently set on the reader.
getControlSchema(String, String[]) - Method in interface io.xlate.edi.schema.SchemaFactory: Retrieve the control schema for the provided standard and version.
getCountType() - Method in interface io.xlate.edi.schema.EDIControlType: Get the type of structures
getData() - Method in exception io.xlate.edi.stream.EDIValidationException: Get the data associated with the validation error
getDelimiters() - Method in interface io.xlate.edi.stream.EDIStreamReader: Retrieve a read-only map of delimiters in use for the stream being read.
getDelimiters() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Retrieve a read-only map of delimiters in use for the stream being written.
getDescription() - Method in interface io.xlate.edi.schema.EDIReference: Retrieve the description for this reference, if available.
getDescription() - Method in interface io.xlate.edi.schema.EDIType: Retrieve the description for this type, if available.
getDiscriminator() - Method in interface io.xlate.edi.schema.implementation.PolymorphicImplementation
getEDIReporter() - Method in class io.xlate.edi.stream.EDIInputFactory: Deprecated.
use EDIInputFactory.getErrorReporter() instead
getElementOccurrence() - Method in interface io.xlate.edi.stream.Location: Return the current occurrence number of a repeating data element, returns 1 for non-repeating elements and -1 if otherwise not available.
getElementPosition() - Method in interface io.xlate.edi.schema.EDIElementPosition: Get the element position within a segment.
getElementPosition() - Method in interface io.xlate.edi.stream.Location: Return the element position within the current segment, returns -1 if none is available.
getError() - Method in exception io.xlate.edi.stream.EDIValidationException: Get the type of validation error
getErrorReporter() - Method in class io.xlate.edi.stream.EDIInputFactory: Retrieves the reporter that will be set on any EDIStreamReader created by this factory instance.
getErrorReporter() - Method in class io.xlate.edi.stream.EDIOutputFactory: Retrieves the reporter that will be set on any EDIStreamWriter created by this factory instance.
getErrorType() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns an integer code that indicates the type of error the cursor is pointing to.
getEvent() - Method in exception io.xlate.edi.stream.EDIValidationException: Get the stream event associated with the error
getEventType() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns an integer code that indicates the type of the event the cursor is pointing to.
getHeaderRefPosition() - Method in interface io.xlate.edi.schema.EDIControlType: Get the position of the element within the header segment that is used as the control reference/number for the envelope.
getId() - Method in interface io.xlate.edi.schema.EDIType
getImplementation() - Method in interface io.xlate.edi.schema.Schema: Retrieve the LoopImplementation that is the entry point of the implementation schema.
getLevelIdPosition() - Method in interface io.xlate.edi.schema.EDILoopType: For hierarchical loops, get the position of the element within the first segment that identifies the loop.
getLineNumber() - Method in interface io.xlate.edi.stream.Location: Return the line number where the current event ends, returns -1 if none is available.
getLocation() - Method in exception io.xlate.edi.schema.EDISchemaException: Gets the location of the exception
getLocation() - Method in exception io.xlate.edi.stream.EDIStreamException: Gets the location of the exception
getLocation() - Method in interface io.xlate.edi.stream.EDIStreamReader: Return the current location of the processor.
getLocation() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Return the current location of the writer.
getLocation() - Method in exception io.xlate.edi.stream.EDIValidationException: Get the location of the validation error
getMainLoop() - Method in interface io.xlate.edi.schema.Schema: Deprecated.
use Schema.getStandard() instead
getMaxLength() - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the maxLength attribute of the element.
getMaxLength(String) - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the maxLength attribute for a particular version of the element.
getMaxOccurs() - Method in interface io.xlate.edi.schema.EDIReference
getMaxOccurs(String) - Method in interface io.xlate.edi.schema.EDIReference: Retrieve the maxOccurs attribute for a particular version of the element.
getMinLength() - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the minLength attribute of the element.
getMinLength(String) - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the minLength attribute for a particular version of the element.
getMinOccurs() - Method in interface io.xlate.edi.schema.EDIReference
getMinOccurs(String) - Method in interface io.xlate.edi.schema.EDIReference: Retrieve the minOccurs attribute for a particular version of the element.
getNextException() - Method in exception io.xlate.edi.stream.EDIValidationException: Retrieves the exception chained to this EDIValidationException object by setNextException(EDIValidationException ex).
getNumber() - Method in interface io.xlate.edi.schema.EDISimpleType: Deprecated.
(since 1.8, for removal) use EDIType.getCode() and code attribute instead
getOriginalMessage() - Method in exception io.xlate.edi.schema.EDISchemaException
getParentIdPosition() - Method in interface io.xlate.edi.schema.EDILoopType: For hierarchical loops, get the position of the element within the first segment that identifies the parent of the loop.
getPositions() - Method in interface io.xlate.edi.schema.EDISyntaxRule
getProperty(String) - Method in interface io.xlate.edi.schema.SchemaFactory: Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in interface io.xlate.edi.stream.EDIStreamReader: Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Get the value of a feature/property from the underlying implementation
getProperty(String) - Method in class io.xlate.edi.stream.PropertySupport: Get the value of a feature/property from the underlying implementation
getReferenceCode() - Method in interface io.xlate.edi.stream.EDIStreamReader: Return the reference code for the current element if a schema has been set and the current processing state is within an interchange.
getReferencedType() - Method in interface io.xlate.edi.schema.EDIReference
getReferences() - Method in interface io.xlate.edi.schema.EDIComplexType: Retrieve the EDIReferences (child elements) for a this complex type.
getScale() - Method in interface io.xlate.edi.schema.EDISimpleType: Returns the scale of this EDISimpleType when the base is NUMERIC.
getSchemaTypeReference() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns an EDIReference for the schema type at the current point in the reader's input stream.
getSegmentPosition() - Method in interface io.xlate.edi.stream.Location: Return the segment position within the current stream, returns -1 if none is available.
getSegmentTag() - Method in interface io.xlate.edi.stream.Location: Return the segment tag within the current stream, returns null if none is available.
getSequence() - Method in interface io.xlate.edi.schema.implementation.CompositeImplementation
getSequence() - Method in interface io.xlate.edi.schema.implementation.PolymorphicImplementation
getStandard() - Method in interface io.xlate.edi.schema.Schema: Retrieve the EDIComplexType that is the entry point of the standard schema.
getStandard() - Method in interface io.xlate.edi.stream.EDIStreamReader: Get the EDI standard name.
getStandard() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Get the EDI standard name.
getSyntaxRules() - Method in interface io.xlate.edi.schema.EDIComplexType: Retrieve the EDISyntaxRules associated with this EDIComplexType.
getText() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns the current value of the parse event as a string.
getTextCharacters() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns an array which contains the characters from this event (as specified by getText()).
getTextCharacters(int, char[], int, int) - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns the the text associated with an event (as specified by getText()).
getTextLength() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns the length of the sequence of characters for this Text event within the text character array.
getTextStart() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns the offset into the text character array where the first character (of this text event) is stored.
getTitle() - Method in interface io.xlate.edi.schema.EDIReference: Retrieve the title for this reference, if available.
getTitle() - Method in interface io.xlate.edi.schema.EDIType: Retrieve the title for this type, if available.
getTrailerCountPosition() - Method in interface io.xlate.edi.schema.EDIControlType: Get the position of the element within the trailer segment that is used as the control count for the envelope.
getTrailerRefPosition() - Method in interface io.xlate.edi.schema.EDIControlType: Get the position of the element within the trailer segment that is used as the control reference/number for the envelope.
getTransactionSchema() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns the schema currently set on the reader to be used for validation of the business transaction.
getTransactionType() - Method in interface io.xlate.edi.stream.EDIStreamReader: The transaction type string as received in a standard-specific location.
getTransactionVersion() - Method in interface io.xlate.edi.stream.EDIStreamReader: Get the transaction version declared on the transaction header segment or the functional group header segment (X12 only).
getTransactionVersionString() - Method in interface io.xlate.edi.stream.EDIStreamReader: The transaction version string elements as a single, period-delimited value.
getType() - Method in interface io.xlate.edi.schema.EDISyntaxRule
getType() - Method in interface io.xlate.edi.schema.EDIType
getType() - Method in interface io.xlate.edi.schema.implementation.CompositeImplementation
getType() - Method in interface io.xlate.edi.schema.implementation.ElementImplementation
getType() - Method in interface io.xlate.edi.schema.implementation.LoopImplementation
getType() - Method in interface io.xlate.edi.schema.implementation.SegmentImplementation
getType(String) - Method in interface io.xlate.edi.schema.Schema: Retrieve an EDIType by name.
getValues() - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the mapping of enumerated values allowed for this element with the associated title values.
getValues(String) - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the mapping of enumerated values allowed for this element with the associated title values for a particular version of the element.
getValueSet() - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the set of enumerated values allowed for this element.
getValueSet() - Method in interface io.xlate.edi.schema.implementation.Discriminator
getValueSet(String) - Method in interface io.xlate.edi.schema.EDISimpleType: Retrieve the set of enumerated values allowed for this element for a particular version of the element.
getVersion() - Method in interface io.xlate.edi.stream.EDIStreamReader: Get the interchange version declared on the interchange begin segment.
GROUP - Enum constant in enum io.xlate.edi.schema.EDIType.Type

H

hasNext() - Method in interface io.xlate.edi.stream.EDIStreamReader: Returns true if there are more parsing events and false if there are no more events.
hasText() - Method in interface io.xlate.edi.stream.EDIStreamReader: Return true if the current event has text, false otherwise.
hasVersions() - Method in interface io.xlate.edi.schema.EDIReference: Returns true if this element has additional version(s) defined beyond the default.
hasVersions() - Method in interface io.xlate.edi.schema.EDISimpleType: Returns true if this element has additional version(s) defined beyond the default.
hasVersions() - Method in interface io.xlate.edi.schema.implementation.ElementImplementation

I

IDENTIFIER - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base
IMPLEMENTATION_DEPENDENT_DATA_ELEMENT_MISSING - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.
IMPLEMENTATION_DEPENDENT_SEGMENT_MISSING - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.
IMPLEMENTATION_DEPENDENT_UNUSED_DATA_ELEMENT_PRESENT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.
IMPLEMENTATION_DEPENDENT_UNUSED_SEGMENT_PRESENT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.
IMPLEMENTATION_INVALID_CODE_VALUE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element contains a value that is not present in the set of values configured in the implementation schema.
IMPLEMENTATION_LOOP_OCCURS_UNDER_MINIMUM_TIMES - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Loop is defined with a minimum number of occurrences in the implementation schema but too few were encountered in the data stream.
IMPLEMENTATION_PATTERN_MATCH_FAILURE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.
IMPLEMENTATION_SEGMENT_BELOW_MINIMUM_USE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment is defined with a minimum number of occurrences in the implementation schema but too few were encountered in the data stream.
IMPLEMENTATION_TOO_FEW_REPETITIONS - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is defined with a minimum number of occurrences in the implementation schema but too few were encountered in the data stream.
IMPLEMENTATION_UNUSED_DATA_ELEMENT_PRESENT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is defined as unused (maximum use is zero) in the schema but was encountered in the data stream.
IMPLEMENTATION_UNUSED_SEGMENT_PRESENT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment is defined as unused (maximum use is zero) in the schema but was encountered in the data stream.
INTERCHANGE - Enum constant in enum io.xlate.edi.schema.EDIType.Type
INVALID_CHARACTER_DATA - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element contains invalid character data.
INVALID_CODE_VALUE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element contains a value that is not present in the set of values configured in the schema.
INVALID_DATE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is defined with type EDISimpleType.Base.DATE but the data encountered does not match formatted as a date.
INVALID_TIME - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is defined with type EDISimpleType.Base.TIME but the data encountered does not match formatted as a time.
io.xlate.edi.internal - package io.xlate.edi.internal
io.xlate.edi.schema - package io.xlate.edi.schema
io.xlate.edi.schema.implementation - package io.xlate.edi.schema.implementation
io.xlate.edi.stream - package io.xlate.edi.stream
io.xlate.staedi - module io.xlate.staedi: StAEDI is a streaming API for EDI reading, writing, and validation in Java.
isError() - Method in enum io.xlate.edi.stream.EDIStreamEvent: Indicates whether a particular EDIStreamEvent represents a validation error.
isPropertySupported(String) - Method in interface io.xlate.edi.schema.SchemaFactory: Query the set of properties that this factory supports.
isPropertySupported(String) - Method in class io.xlate.edi.stream.PropertySupport: Query the set of properties that this factory supports.
isType(EDIType.Type) - Method in interface io.xlate.edi.schema.EDIType

J

JSON_NULL_EMPTY_ELEMENTS - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, simple data elements not containing data will be represented via the JSON parsers as a null value.
JSON_OBJECT_ELEMENTS - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, simple data elements will be represented via the JSON parsers as JSON objects.

L

LIST - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: Type L EDIFACT: (D6) If first, then at least one more
location - Variable in exception io.xlate.edi.schema.EDISchemaException
location - Variable in exception io.xlate.edi.stream.EDIStreamException: Location of the exception
location - Variable in exception io.xlate.edi.stream.EDIValidationException: Location of the exception
Location - Interface in io.xlate.edi.stream: Provides information on the location of an event.
LOOP - Enum constant in enum io.xlate.edi.schema.EDIType.Type
LOOP_OCCURS_OVER_MAXIMUM_TIMES - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Loop encountered in the data stream has more occurrences than allowed by the configured schema.
LoopImplementation - Interface in io.xlate.edi.schema.implementation
LOOPS - Static variable in class io.xlate.edi.stream.EDINamespaces: XML namespace used for all loop types: INTERCHANGE, GROUP, TRANSACTIONS, and internal message loops.

M

MANDATORY_SEGMENT_MISSING - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment was defined (via a schema) with a minimum number of occurrences, but the number of occurrences encountered in the data stream does not meet the requirement.
matchesLocation(Location) - Method in interface io.xlate.edi.schema.EDIElementPosition: Determine if the given location's element and component matches this element position specification.
message - Variable in exception io.xlate.edi.schema.EDISchemaException

N

newFactory() - Static method in interface io.xlate.edi.schema.SchemaFactory: Create a new instance of the factory.
newFactory() - Static method in class io.xlate.edi.stream.EDIInputFactory: Create a new instance of the factory.
newFactory() - Static method in class io.xlate.edi.stream.EDIOutputFactory: Create a new instance of the factory.
next() - Method in interface io.xlate.edi.stream.EDIStreamReader: Get next parsing event
nextTag() - Method in interface io.xlate.edi.stream.EDIStreamReader: Skips any ELEMENT_DATA, START_COMPOSITE, and END_COMPOSITE until a START_SEGMENT is reached.
NONE - Enum constant in enum io.xlate.edi.schema.EDIControlType.Type: Nothing will be counted or validated
NONE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: No error
NUMERIC - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base

P

PAIRED - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: Type P EDIFACT: (D2) All or none
PolymorphicImplementation - Interface in io.xlate.edi.schema.implementation
PRETTY_PRINT - Static variable in class io.xlate.edi.stream.EDIOutputFactory: When set to true, the EDI output will have a platform specific line separator written after each segment terminator.
properties - Variable in class io.xlate.edi.stream.PropertySupport: Map of properties actually configured by the subclass.
PropertySupport - Class in io.xlate.edi.stream: Abstract parent class for factories that support setting, retrieving, and checking whether properties are supported.
PropertySupport() - Constructor for class io.xlate.edi.stream.PropertySupport: Default constructor, initialize fields to empty collections.

R

RELEASE - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Delimiters: Key for the character used as a release character, allowing the next character in the EDI stream to be treated as data element text rather than a delimiter.
REPETITION - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Delimiters: Key for the delimiter used to terminate/end a repeating data element.
report(EDIStreamValidationError, EDIStreamReader) - Method in interface io.xlate.edi.stream.EDIInputErrorReporter: Report the desired message in an application specific format.
report(EDIStreamValidationError, EDIStreamWriter, Location, CharSequence, EDIReference) - Method in interface io.xlate.edi.stream.EDIOutputErrorReporter: Report the desired message in an application specific format.
REQUIRED - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: Type R EDIFACT: (D3) One or more
REQUIRED_DATA_ELEMENT_MISSING - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element was defined (via a schema) with a minimum number of occurrences but the number of occurrences encountered in the data stream does not meet the requirement.
run() - Method in interface io.xlate.edi.internal.ThrowingRunnable: Run any code provided by an implementation, including code that may throw an exception.
run(ThrowingRunnable<T>, Function<T, E>) - Static method in interface io.xlate.edi.internal.ThrowingRunnable: Execute the provided task and apply the given exceptionWrapper function on any exception thrown by it.

S

Schema - Interface in io.xlate.edi.schema
SCHEMA_LOCATION_URL_CONTEXT - Static variable in interface io.xlate.edi.schema.SchemaFactory: Property key for a URL (java.lang.String or java.net.URL) to be used with relative file URLs in <include schemaLocation="..."> element/attributes processed by a SchemaFactory.
SchemaFactory - Interface in io.xlate.edi.schema
SEGMENT - Enum constant in enum io.xlate.edi.schema.EDIType.Type
SEGMENT - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Delimiters: Key for the delimiter used to terminate/end a segment.
SEGMENT_ERROR - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for an error relating to a segment
SEGMENT_EXCEEDS_MAXIMUM_USE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment encountered in the data stream has more occurrences than allowed by the configured schema.
SEGMENT_EXCLUSION_CONDITION_VIOLATED - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment is configured as conditionally excluded (relative to other segments in the loop) in the schema but was present in the data stream.
SEGMENT_HAS_DATA_ELEMENT_ERRORS - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.
SEGMENT_NOT_IN_DEFINED_TRANSACTION_SET - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: An unrecognized (undefined) segment was encountered in the data stream.
SEGMENT_NOT_IN_PROPER_SEQUENCE - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment was encountered out of order.
SegmentImplementation - Interface in io.xlate.edi.schema.implementation
SEGMENTS - Enum constant in enum io.xlate.edi.schema.EDIControlType.Type: Indicates that the element identified by EDIControlType.getTrailerCountPosition() will contain a count of the segments within the EDIControlType, including the header and trailer segments.
SEGMENTS - Static variable in class io.xlate.edi.stream.EDINamespaces: XML namespace used for EDI segments
setBinaryDataLength(long) - Method in interface io.xlate.edi.stream.EDIStreamReader: Sets the number of bytes that should be read as binary data and not interpreted as EDI data.
setControlSchema(Schema) - Method in interface io.xlate.edi.stream.EDIStreamReader: Sets the schema to be used for validation of the control structure for this stream reader.
setControlSchema(Schema) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Sets the schema to be used for validation of the control structure for this stream writer.
setEDIReporter(EDIReporter) - Method in class io.xlate.edi.stream.EDIInputFactory: Deprecated.
use EDIInputFactory.setErrorReporter(EDIInputErrorReporter) instead
setErrorReporter(EDIInputErrorReporter) - Method in class io.xlate.edi.stream.EDIInputFactory: The reporter that will be set on any EDIStreamReader created by this factory instance.
setErrorReporter(EDIOutputErrorReporter) - Method in class io.xlate.edi.stream.EDIOutputFactory: The reporter that will be set on any EDIStreamWriter created by this factory instance.
setNextException(EDIValidationException) - Method in exception io.xlate.edi.stream.EDIValidationException: Adds an EDIValidationException object to the end of the chain.
setProperty(String, Object) - Method in interface io.xlate.edi.schema.SchemaFactory: Allows the user to set specific feature/property on the underlying implementation.
setProperty(String, Object) - Method in class io.xlate.edi.stream.PropertySupport: Allows the user to set specific feature/property on the underlying implementation.
setTransactionSchema(Schema) - Method in interface io.xlate.edi.stream.EDIStreamReader: Sets the schema to be used for validation of the business transaction for this stream reader.
setTransactionSchema(Schema) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Sets the schema to be used for validation of the business transaction for this stream writer.
SINGLE - Enum constant in enum io.xlate.edi.schema.EDISyntaxRule.Type: X12: N/A EDIFACT: (D1) One and only one
START_COMPOSITE - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the start of a composite element.
START_GROUP - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the start of a functional group.
START_INTERCHANGE - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the start of an interchange.
START_LOOP - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the start of a data loop (logical grouping of segments).
START_SEGMENT - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the start of a segment.
START_TRANSACTION - Enum constant in enum io.xlate.edi.stream.EDIStreamEvent: Event for the start of a transaction.
startComponent() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Start a component of a composite element.
startInterchange() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Initialize this writer to begin writing an interchange.
STRING - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base
supportedProperties - Variable in class io.xlate.edi.stream.PropertySupport: Set of property keys/names supported by the subclass.

T

ThrowingRunnable<T extends Exception> - Interface in io.xlate.edi.internal: A Runnable that can throw exceptions/errors.
TIME - Enum constant in enum io.xlate.edi.schema.EDISimpleType.Base
TOO_MANY_COMPONENTS - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element contains more components than defined by the configured schema.
TOO_MANY_DATA_ELEMENTS - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element is configured as conditionally required (relative to other elements in the segment) in the schema but was not present in the data stream.
TOO_MANY_REPETITIONS - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Element repeats more times than allowed by the configured schema.
TRADACOMS - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Standards: Constant name for the TRADACOMS EDI Dialect
TRANSACTION - Enum constant in enum io.xlate.edi.schema.EDIType.Type
TRUNCATE_EMPTY_ELEMENTS - Static variable in class io.xlate.edi.stream.EDIOutputFactory: When set to true, empty trailing elements in a segment and empty trailing components in a composite element will be truncated.

U

UNEXPECTED_SEGMENT - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Segment was received in an unexpected position in the data stream.
UNRECOGNIZED_SEGMENT_ID - Enum constant in enum io.xlate.edi.stream.EDIStreamValidationError: Deprecated.
Not used by StAEDI - reserved for future use.

V

valueOf(String) - Static method in enum io.xlate.edi.schema.EDIControlType.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.xlate.edi.schema.EDISimpleType.Base: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.xlate.edi.schema.EDISyntaxRule.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.xlate.edi.schema.EDIType.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.xlate.edi.stream.EDIStreamEvent: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.xlate.edi.stream.EDIStreamValidationError: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.xlate.edi.schema.EDIControlType.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.xlate.edi.schema.EDISimpleType.Base: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.xlate.edi.schema.EDISyntaxRule.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.xlate.edi.schema.EDIType.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.xlate.edi.stream.EDIStreamEvent: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.xlate.edi.stream.EDIStreamValidationError: Returns an array containing the constants of this enum type, in the order they are declared.

W

writeBinaryData(byte[], int, int) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write binary data from the given byte array to the output.
writeBinaryData(InputStream) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write binary data from the given InputStream to the output.
writeBinaryData(ByteBuffer) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write binary data from the given buffer to the output.
writeComponent(char[], int, int) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Begin a component element, write text data from the given char array to the output, and end the element.
writeComponent(CharSequence) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Begin a component element, write text data from the given CharSequence to the output, and end the element.
writeElement(char[], int, int) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Begin an element, write text data from the given char array to the output, and end the element.
writeElement(CharSequence) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Begin an element, write text data from the given CharSequence to the output, and end the element.
writeElementData(char[], int, int) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write text data from the given char array to the output.
writeElementData(CharSequence) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write text data from the given CharSequence to the output.
writeEmptyComponent() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write an empty component
writeEmptyElement() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write an empty simple element.
writeEndSegment() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Complete a segment by writing the segment terminator to the underlying output.
writeRepeatElement() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Write an element repeat delimiter/separator to the output stream.
writeStartElement() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Start a new element, composite or simple.
writeStartElementBinary() - Method in interface io.xlate.edi.stream.EDIStreamWriter: Start a new element for binary data.
writeStartSegment(String) - Method in interface io.xlate.edi.stream.EDIStreamWriter: Begin a new segment with the given name and write the tag to the underlying output.

X

X12 - Static variable in class io.xlate.edi.stream.EDIStreamConstants.Standards: Constant name for the X12 EDI Dialect
XML_DECLARE_TRANSACTION_XMLNS - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, XMLStreamReader instances created from an EDIInputFactory will generate XMLNS attributes on the TRANSACTION element in addition to the INTERCHANGE element.
XML_USE_SEGMENT_IMPLEMENTATION_CODES - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, the XML elements representing segments in an EDI implementation schema will be named according to the schema-defined code attribute for the segment.
XML_WRAP_TRANSACTION_CONTENTS - Static variable in class io.xlate.edi.stream.EDIInputFactory: When set to true, XMLStreamReader instances created from an EDIInputFactory will generate an element wrapper around the transaction's content element.

A B C D E F G H I J L M N P R S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form