org.xbrlapi.impl
Class StubImpl

java.lang.Object
  org.xbrlapi.impl.XMLImpl
      org.xbrlapi.impl.NonFragmentXMLImpl
          org.xbrlapi.impl.StubImpl

All Implemented Interfaces:

Serializable, Comparable<XML>, NonFragmentXML, Stub, XML

public class StubImpl
extends NonFragmentXMLImpl
implements Stub

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

StubImpl()
No argument constructor.

StubImpl(String id, URI uri, String reason)

Method Summary

String	getReason()
URI	getResourceURI()
void	setReason(String reason)
void	setResourceURI(URI uri)

Methods inherited from class org.xbrlapi.impl.NonFragmentXMLImpl

finalizeBuilder

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

StubImpl

public StubImpl()
         throws XBRLException

No argument constructor.

Throws:

XBRLException

StubImpl

public StubImpl(String id,
                URI uri,
                String reason)
         throws XBRLException

Parameters:

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

Throws:

XBRLException

Method Detail

getReason

public String getReason()
                 throws XBRLException

Specified by:

getReason in interface Stub

Returns:

the reason that the stub was stored.

Throws:

XBRLException

See Also:

Stub.getReason()

getResourceURI

public URI getResourceURI()
                   throws XBRLException

Specified by:

getResourceURI in interface Stub

Returns:

the URI of the affected document.

Throws:

XBRLException - if the URI syntax is incorrect.

See Also:

Stub.getResourceURI()

setResourceURI

public void setResourceURI(URI uri)
                    throws XBRLException

Specified by:

setResourceURI in interface Stub

Parameters:

uri - the URI of the document described by the stub.

Throws:

XBRLException - if the URI is null

See Also:

Stub.setResourceURI(URI)

setReason

public void setReason(String reason)
               throws XBRLException

Specified by:

setReason in interface Stub

Parameters:

reason - The reason for the stub to exist.

Throws:

XBRLException - if the reason is null

See Also:

Stub.setReason(String)