org.ceryle.wiki.plugin.query
Interface ReferenceInfoProvider

All Known Implementing Classes:

ReferenceManagerInfoProvider, WikiPage

public interface ReferenceInfoProvider

In order to evaluate a query a provider of reference information is required. The ReferenceManager is the obvious place to get the needed information. This interface was introduced to allow other sources to be used (information obtained via XML-RPC for example).

Author:

John Volkar (john.volkar at gmail.com)

Method Summary

Collection	getAllPages()
Collection	getReferredBy(String candidateName)
Collection	getRefersTo(String candidateName)
int	getSignature() This 'signature' can be used to determine if there were any modifications made to the underlying to and by maps of the ReferenceManager.

Method Detail

getRefersTo

Collection getRefersTo(String candidateName)

getReferredBy

Collection getReferredBy(String candidateName)

getSignature

int getSignature()

This 'signature' can be used to determine if there were any modifications made to the underlying to and by maps of the ReferenceManager. This method traps and retries if a concurrent modifcaition occurs. The maps of the ReferenceManager are not synchronized, so someone could add/remove entries in them while the hashCodes are being computed.

Returns:

Sum of the hashCodes for the to and by maps of the ReferenceManager

getAllPages

Collection getAllPages()