org.xbrlapi.impl
Class ErrorImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.ErrorImpl

All Implemented Interfaces:

Serializable, Comparable<XML>, Error, XML

public class ErrorImpl
extends XMLImpl
implements Error

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

ErrorImpl()
No argument constructor.

ErrorImpl(String id)

ErrorImpl(String id, URI document, String explanation)
Use this constructor if the problem is not related to a specific fragment.

ErrorImpl(String id, URI document, String index, String explanation)

Method Summary

String	getExplanation()
String	getProblemIndex()
URI	getProblemURI()
void	setExplanation(String problem)
void	setProblemIndex(String index) The index can be null if the problem cannot be sheeted back to a specific fragment.
void	setResourceURI(URI uri)

Methods inherited from class org.xbrlapi.impl.XMLImpl

appendMetadataElement, compareTo, equals, finalize, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

ErrorImpl

public ErrorImpl()
          throws XBRLException

No argument constructor.

Throws:

XBRLException

ErrorImpl

public ErrorImpl(String id)
          throws XBRLException

Parameters:

id - The unique id of the error being created. within the scope of the containing data store.

Throws:

XBRLException

ErrorImpl

public ErrorImpl(String id,
                 URI document,
                 String explanation)
          throws XBRLException

Use this constructor if the problem is not related to a specific fragment.

Parameters:

id - The unique id of the error being created.

document - The URI of the affected document.

explanation - The explanation of the problem.

Throws:

XBRLException

ErrorImpl

public ErrorImpl(String id,
                 URI document,
                 String index,
                 String explanation)
          throws XBRLException

Parameters:

id - The unique id of the error being created.

document - The URI of the affected document.

index - The index of the fragment causing the problem.

explanation - The explanation of the problem.

Throws:

XBRLException

Method Detail

getProblemIndex

public String getProblemIndex()
                       throws XBRLException

Specified by:

getProblemIndex in interface Error

Returns:

the index of the problematic fragment.

Throws:

XBRLException - if the URI syntax is incorrect.

See Also:

Error.getProblemIndex()

setProblemIndex

public void setProblemIndex(String index)
                     throws XBRLException

Description copied from interface: Error

The index can be null if the problem cannot be sheeted back to a specific fragment.

Specified by:

setProblemIndex in interface Error

Parameters:

index - The index of the fragment causing the problem.

Throws:

XBRLException

See Also:

Error.setProblemIndex(String)

getProblemURI

public URI getProblemURI()
                  throws XBRLException

Specified by:

getProblemURI in interface Error

Returns:

the URI of the affected document.

Throws:

XBRLException - if the URI syntax is incorrect.

See Also:

Error.getProblemURI()

setResourceURI

public void setResourceURI(URI uri)
                    throws XBRLException

Specified by:

setResourceURI in interface Error

Parameters:

uri - the URI of the document causing the problem.

Throws:

XBRLException - if the URI is null

See Also:

Error.setResourceURI(URI)

setExplanation

public void setExplanation(String problem)
                    throws XBRLException

Specified by:

setExplanation in interface Error

Parameters:

problem - The problem explanation.

Throws:

XBRLException - if the explanation is null

See Also:

Error.setExplanation(String)

getExplanation

public String getExplanation()
                      throws XBRLException

Specified by:

getExplanation in interface Error

Returns:

the problem explanation.

Throws:

XBRLException

See Also:

Error.getExplanation()