com.ddtek.xmlconverter.exception
Class ConverterException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.io.IOException
              extended by com.ddtek.xmlconverter.exception.ConverterException
All Implemented Interfaces:
com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails, com.ddtek.xmlconverter.adapter.edi.EDISegmentLocator, Serializable
Direct Known Subclasses:
ConverterArgumentException, ConverterCancelledException, EDIConverterException, InvalidFormatException

public class ConverterException
extends IOException
implements com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

Most Exceptions from DataDirect XML Converters are reported as instances of this exception or its subclasses. In some cases, where the interface between the XML Converter and the application is a standard interface such as ContentHandler or XMLStreamReader, the type of exception thrown is dictated by the interface definition.

See Also:
Serialized Form

Field Summary
protected  String m_errorCode
           
 
Constructor Summary
 
Method Summary
 int getDataLine()
           
 int getEndOffset()
           
 int getError()
           
 String getErrorCode()
          Many converters and utility methods provide specific indicators that represent the thrown exception type.
 com.ddtek.xmlconverter.adapter.ConverterContext getErrorContext()
           
 int getErrorLine()
           
 int getLine()
           
 int getOffset()
           
 String getSegment()
           
 int getSegmentLength()
           
 int getSegmentNumber()
           
 com.ddtek.xmlconverter.adapter.edi.Segment getSegmentObj()
           
 com.ddtek.xmlconverter.utilities.StrBuilder getSupplementalInfo()
           
 void setSegment(com.ddtek.xmlconverter.adapter.edi.Segment seg)
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails
getMessage
 

Field Detail

m_errorCode

protected String m_errorCode
Constructor Detail
Method Detail

getEndOffset

public int getEndOffset()
Specified by:
getEndOffset in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getError

public int getError()
Specified by:
getError in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getErrorContext

public com.ddtek.xmlconverter.adapter.ConverterContext getErrorContext()
Specified by:
getErrorContext in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getErrorLine

public int getErrorLine()
Specified by:
getErrorLine in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getLine

public int getLine()
Specified by:
getLine in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getOffset

public int getOffset()
Specified by:
getOffset in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getSegmentLength

public int getSegmentLength()
Specified by:
getSegmentLength in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getSupplementalInfo

public com.ddtek.xmlconverter.utilities.StrBuilder getSupplementalInfo()
Specified by:
getSupplementalInfo in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails

getDataLine

public int getDataLine()
Specified by:
getDataLine in interface com.ddtek.xmlconverter.adapter.edi.EDISegmentLocator

getSegment

public String getSegment()
Specified by:
getSegment in interface com.ddtek.xmlconverter.adapter.edi.EDISegmentLocator

getSegmentNumber

public int getSegmentNumber()
Specified by:
getSegmentNumber in interface com.ddtek.xmlconverter.adapter.edi.EDISegmentLocator

getSegmentObj

public com.ddtek.xmlconverter.adapter.edi.Segment getSegmentObj()
Specified by:
getSegmentObj in interface com.ddtek.xmlconverter.adapter.edi.EDISegmentLocator

setSegment

public void setSegment(com.ddtek.xmlconverter.adapter.edi.Segment seg)
Specified by:
setSegment in interface com.ddtek.xmlconverter.adapter.edi.EDISegmentLocator

getErrorCode

public String getErrorCode()
Many converters and utility methods provide specific indicators that represent the thrown exception type. This returns that value as a string generally of four letters followed by four digits.

Specified by:
getErrorCode in interface com.ddtek.xmlconverter.adapter.edi.EDIErrorDetails
Returns:
Specific error code for converters or steps that support them, or null.