org.xbrlapi.data.resource

Class BaseMatcherImpl

java.lang.Object

org.xbrlapi.data.resource.BaseMatcherImpl

All Implemented Interfaces:

java.io.Serializable, Matcher

Direct Known Subclasses:

InMemoryMatcherImpl, InStoreMatcherImpl

public abstract class BaseMatcherImpl
extends java.lang.Object
implements Matcher

Author:

Geoffrey Shuetrim (geoff@galexy.net)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseMatcherImpl(Cache cache, Signer signature)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getSignature(java.net.URI uri)
int	hashCode()
void	setSigner(Signer signer) Call this method if you need to use a different signature generator for the resources you are working with.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xbrlapi.data.resource.Matcher

delete, getAllMatchingURIs, getMatch, hasURI

Constructor Detail

BaseMatcherImpl

public BaseMatcherImpl(Cache cache,
               Signer signature)
                throws XBRLException

Parameters:

cache - The resource cache to be used by the matcher when accessing resources to determine their signature.

signature - The object used to generate resource signatures.

Throws:

XBRLException - if either parameter is null.

Method Detail

setSigner

public void setSigner(Signer signer)

Description copied from interface: Matcher

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

Specified by:

setSigner in interface Matcher

Parameters:

signer - The object used to generate signatures.

getSignature

public java.lang.String getSignature(java.net.URI uri)
                              throws XBRLException

Specified by:

getSignature in interface Matcher

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 accessed.

Throws:

XBRLException - if the signature cannot be constructed.

See Also:

Matcher.getSignature(URI)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object