org.xbrlapi

Interface Match

All Superinterfaces:

java.lang.Comparable<XML>, NonFragmentXML, java.io.Serializable, XML

All Known Implementing Classes:

MatchImpl

public interface Match
extends NonFragmentXML

Used to store URI mapping information about identical documents.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

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

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

Method Detail

addMatchedURI

void addMatchedURI(java.net.URI uri)
                   throws XBRLException

Parameters:

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

Throws:

XBRLException - if the URI is null.

getMatch

java.net.URI getMatch()
                      throws XBRLException

Returns:

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

Throws:

XBRLException - if the matching URI has invalid syntax.

deleteURI

void deleteURI(java.net.URI uri)
               throws XBRLException

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

Parameters:

uri - The URI to eliminate from the match resource.

Throws:

XBRLException

getURIs

java.util.List<java.net.URI> getURIs()
                                     throws XBRLException

Returns:

a list of all URIs matched through this match resource.

Throws:

XBRLException