Module io.xlate.staedi
Package io.xlate.edi.internal.stream

Class StaEDIStreamReader

    • Method Detail

      • getProperty

        public Object getProperty​(String name)
        Description copied from interface: EDIStreamReader
        Get the value of a feature/property from the underlying implementation
        Specified by:
        getProperty in interface EDIStreamReader
        Parameters:
        name - - The name of the property, may not be null
        Returns:
        The value of the property

      • nextTag

        public EDIStreamEvent nextTag()
                       throws EDIStreamException
        Description copied from interface: EDIStreamReader
        Skips any ELEMENT_DATA, START_COMPOSITE, and END_COMPOSITE until a START_SEGMENT is reached.
        Specified by:
        nextTag in interface EDIStreamReader
        Returns:
        the event type of the element read - START_SEGMENT
        Throws:
        EDIStreamException - if the current event is not following START_INTERCHANGE and preceding END_INTERCHANGE

      • hasNext

        public boolean hasNext()
                throws EDIStreamException
        Description copied from interface: EDIStreamReader
        Returns true if there are more parsing events and false if there are no more events. This method will return false if the current state of the EDIStreamReader is END_INTERCHANGE
        Specified by:
        hasNext in interface EDIStreamReader
        Returns:
        true if there are more events, false otherwise
        Throws:
        EDIStreamException - if there is a fatal error detecting the next state

      • getEventType

        public EDIStreamEvent getEventType()
        Description copied from interface: EDIStreamReader
        Returns an integer code that indicates the type of the event the cursor is pointing to.
        Specified by:
        getEventType in interface EDIStreamReader
        Returns:
        code that indicates the type of the event the cursor is pointing to

      • getStandard

        public String getStandard()
        Description copied from interface: EDIStreamReader
        Get the EDI standard name. Calls to this method are only valid when the interchange type has been determined, after START_INTERCHANGE.
        Specified by:
        getStandard in interface EDIStreamReader
        Returns:
        the name of the EDI standard

      • getVersion

        public String[] getVersion()
        Description copied from interface: EDIStreamReader
        Get the interchange version declared on the interchange begin segment. Calls to this method are only valid when interchange type has been determined, after START_INTERCHANGE.
        Specified by:
        getVersion in interface EDIStreamReader
        Returns:
        the version

      • setControlSchema

        public void setControlSchema​(Schema schema)
        Description copied from interface: EDIStreamReader

        Sets the schema to be used for validation of the control structure for this stream reader. This schema will be used to validate interchange, group, and transaction/message envelopes.

        Calls to this method are only valid when the current event type is START_INTERCHANGE.

        Specified by:
        setControlSchema in interface EDIStreamReader
        Parameters:
        schema - the schema instance to use for validation of control structures

      • setTransactionSchema

        public void setTransactionSchema​(Schema schema)
        Description copied from interface: EDIStreamReader

        Sets the schema to be used for validation of the business transaction for this stream reader. This schema will be used to validate only the contents of a transaction/message, not including the begin/end control structures.

        Calls to this method are only valid after a START_TRANSACTION event and before the end of the segment representing the beginning of the transaction.

        Specified by:
        setTransactionSchema in interface EDIStreamReader
        Parameters:
        schema - the schema instance to use for validation of business transaction structures

      • getReferenceCode

        public String getReferenceCode()
        Description copied from interface: EDIStreamReader
        Return the reference code for the current element if a schema has been set and the current processing state is within an interchange. Otherwise, an IllegalStateException will be thrown. If the reader encounters an unknown type, the reference code will be null.
        Specified by:
        getReferenceCode in interface EDIStreamReader
        Returns:
        the reference code from the schema for the current EDIType

      • getErrorType

        public EDIStreamValidationError getErrorType()
        Description copied from interface: EDIStreamReader
        Returns an integer code that indicates the type of error the cursor is pointing to. Calls to this method are only valid when the current event type is SEGMENT_ERROR or ELEMENT_ERROR.
        Specified by:
        getErrorType in interface EDIStreamReader
        Returns:
        code that indicates the type of the error the cursor is pointing to

      • getText

        public String getText()
        Description copied from interface: EDIStreamReader
        Returns the current value of the parse event as a string. This returns the string value of an ELEMENT_DATA event, and the string value of a segment tag in a START_SEGMENT event. During an ELEMENT_ERROR event, this contains the invalid element.
        Specified by:
        getText in interface EDIStreamReader
        Returns:
        the current text or null

      • getTextCharacters

        public char[] getTextCharacters()
        Description copied from interface: EDIStreamReader
        Returns an array which contains the characters from this event. This array should be treated as read-only and transient. I.e. the array will contain the text characters until the EDIStreamReader moves on to the next event. Attempts to hold onto the character array beyond that time or modify the contents of the array are breaches of the contract for this interface.
        Specified by:
        getTextCharacters in interface EDIStreamReader
        Returns:
        the current text or an empty array

      • getTextCharacters

        public int getTextCharacters​(int sourceStart,
                             char[] target,
                             int targetStart,
                             int length)
        Description copied from interface: EDIStreamReader
        Gets the the text associated with a ELEMENT_DATA, ELEMENT_ERROR, START_SEGMENT, or END_SEGMENT event. Text starting at "sourceStart" is copied into "target" starting at "targetStart". Up to "length" characters are copied. The number of characters actually copied is returned. The "sourceStart" argument must be greater or equal to 0 and less than or equal to the number of characters associated with the event. Usually, one requests text starting at a "sourceStart" of 0. If the number of characters actually copied is less than the "length", then there is no more text. Otherwise, subsequent calls need to be made until all text has been retrieved. For example: 
         int length = 1024;
 char[] myBuffer = new char[length];

 for (int sourceStart = 0;; sourceStart += length) {
     int nCopied = stream.getTextCharacters(sourceStart, myBuffer, 0, length);
     if (nCopied < length)
         break;
 }
        EDIStreamException may be thrown if there are any parsing errors in the underlying source. The "targetStart" argument must be greater than or equal to 0 and less than the length of "target", Length must be greater than 0 and "targetStart + length" must be less than or equal to length of "target".
        Specified by:
        getTextCharacters in interface EDIStreamReader
        Parameters:
        sourceStart - - the index of the first character in the source array to copy
        target - - the destination array
        targetStart - - the start offset in the target array
        length - - the number of characters to copy
        Returns:
        the number of characters actually copied

      • getTextStart

        public int getTextStart()
        Description copied from interface: EDIStreamReader
        Returns the offset into the text character array where the first character (of this text event) is stored.
        Specified by:
        getTextStart in interface EDIStreamReader
        Returns:
        offset into the text character array where the first character is stored

      • getTextLength

        public int getTextLength()
        Description copied from interface: EDIStreamReader
        Returns the length of the sequence of characters for this Text event within the text character array.
        Specified by:
        getTextLength in interface EDIStreamReader
        Returns:
        length of the sequence of characters for this Text event

      • getLocation

        public Location getLocation()
        Description copied from interface: EDIStreamReader
        Return the current location of the processor. If the Location is unknown the processor should return an implementation of Location that returns -1 for the location values. The location information is only valid until next() is called.
        Specified by:
        getLocation in interface EDIStreamReader
        Returns:
        current location of the processor

      • setBinaryDataLength

        public void setBinaryDataLength​(long length)
                         throws EDIStreamException
        Description copied from interface: EDIStreamReader
        Sets the number of bytes that should be read as binary data and not interpreted as EDI data. This EDIStreamReader will return to normal EDI parsing after reading this number of bytes. The byte immediately following length bytes must be a delimiter valid in the scope of the current interchange or an EDIStreamException will occur. This method must only be called immediately preceding a binary data element. Attempts to call it while the reader is in any other state will result in an IllegalStateException.

        Note: Applications parsing transactions which contain binary data elements must call this method to avoid the binary data being parsed as EDI content. The length of the binary data is typically found in a companion data element preceding the binary element in the stream.

        Specified by:
        setBinaryDataLength in interface EDIStreamReader
        Parameters:
        length - - the number of bytes to read as binary data and not as EDI-formatted
        Throws:
        EDIStreamException - if there are IO errors allocating resources for binary data processing

      • getBinaryData

        public InputStream getBinaryData()
        Description copied from interface: EDIStreamReader
        Returns a ByteBuffer object containing the binary element data read in the previous data element. The limit of the buffer will be set to the length of the data.
        Specified by:
        getBinaryData in interface EDIStreamReader
        Returns:
        buffer containing binary data