org.xbrlapi.impl
Class MatchImpl

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

All Implemented Interfaces:

Serializable, Comparable<XML>, Match, NonFragmentXML, XML

public class MatchImpl
extends NonFragmentXMLImpl
implements Match

Note that the first match child element of the metadata is the URI of the matching document that is actually stored in the data store.

Author:

Geoff Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.xbrlapi.impl.XMLImpl

logger

Constructor Summary

MatchImpl()
No argument constructor.

MatchImpl(String id)

Method Summary

void	addMatchedURI(URI uri)
void	deleteURI(URI uri) Call this method, for example, when a document is deleted from the data store so matching information needs to be updated.
URI	getMatch()
List<URI>	getURIs()

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

MatchImpl

public MatchImpl()
          throws XBRLException

No argument constructor.

Throws:

XBRLException

MatchImpl

public MatchImpl(String id)
          throws XBRLException

Parameters:

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

Throws:

XBRLException

Method Detail

addMatchedURI

public void addMatchedURI(URI uri)
                   throws XBRLException

Specified by:

addMatchedURI in interface Match

Parameters:

uri - The URI to add to the match XML resource.

Throws:

XBRLException - if the URI is null.

See Also:

Match.addMatchedURI(URI)

getMatch

public URI getMatch()
             throws XBRLException

Specified by:

getMatch in interface Match

Returns:

the matching URI defined by this match resource or null if none is defined.

Throws:

XBRLException - if the matching URI has invalid syntax.

See Also:

Match.getMatch()

getURIs

public List<URI> getURIs()
                  throws XBRLException

Specified by:

getURIs in interface Match

Returns:

a list of all URIs matched through this match resource.

Throws:

XBRLException

See Also:

Match.getURIs()

deleteURI

public void deleteURI(URI uri)
               throws XBRLException

Description copied from interface: Match

Call this method, for example, when a document is deleted from the data store so matching information needs to be updated.

Specified by:

deleteURI in interface Match

Parameters:

uri - The URI to eliminate from the match resource.

Throws:

XBRLException

See Also:

Match.deleteURI(URI)