org.xbrlapi.data.resource
Interface Matcher

All Known Implementing Classes:

BaseMatcherImpl, DefaultMatcherImpl, InMemoryMatcherImpl, InStoreMatcherImpl

public interface Matcher

The resource matcher interface, defining all methods that need to be implemented by a resource matcher to support XBRLAPI data stores.

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

URI	getMatch(URI uri)
String	getSignature(URI uri)
void	setSigner(Signer signer) Call this method if you need to use a different signature generator for the resources you are working with.

Method Detail

setSigner

void setSigner(Signer signer)

Call this method if you need to use a different signature generator for the resources you are working with.

Parameters:

signer - The object used to generate signatures.

getSignature

String getSignature(URI uri)
                    throws XBRLException

Parameters:

uri - The URI of the resource to obtain the signature for.

Returns:

the signature for the resource specified by the URI or null if the resource could not be cached (generally because it does not exist).

Throws:

XBRLException - if the signature cannot be constructed.

getMatch

URI getMatch(URI uri)
             throws XBRLException

Parameters:

uri - The URI of the resource to be tested for a match.

Returns:

the URI of the matching resource in the data store if one exists and the original URI otherwise (because it becomes the matching URI in the data store).

Throws:

XBRLException