votorola.a.diff.harvest.cache

Class HarvestCache

java.lang.Object

HarvestCache

@ThreadSafe
public class HarvestCache
extends Object

Pass your messages from the communication media the cache to find and store valid difference messages. The overall process of processing messages in regard to this cache is outlined here:

 
     HarvestCache                      HarvestCache
         ^                                    ^
         |                                    |
         | MessageContext                     | Message
         |                                    |
         |                                    |
     Detectors                       Parse message from HTML (harvester)
     
                        UpdateKick (via Kicker)
  1. Message detection ------------> 2. Archive harvesting
 

The steps of 1. and 2. are completely separated, since we have to parse the information from the web anyway to gain valid URLs for some media. If the Url to the message can be parsed in the detector no harvesting (web scraping) of the archive is necessary and Message objects can directly be used. In fact they both only differ in this very crucial information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HarvestCache.ConstructionContext A context for configuring the construction of a vote-server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHARLIMIT Maximum length of the communication excerpt cut out of the message body.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	check(MessageContext mc, Authenticator av) TODO Examine the message for difference-urls and return whether this message contains valid difference information.
List<String>	findDiffUrls(String searchedString) Lists all interesting difference-urls.
Database	getDatabase() Access the database of this HarvestCache instance.
DiffMessageTable	getTable() Access this table to DiffMessageTable.get(String, String[], int) messages.
static HarvestCache	i() Implemented as singleton.
static HarvestCache	init(VoteServer.Run vsRun) The cache needs access to a VoteServer.Run and must be initialized before usage.
XCastRelation	relation(String author, String addressee, String pollName) TODO was private, privatize again when vote history is available.
boolean	store(Message msg, Authenticator av) Call this once you have a valid message including url to the web, to store it permanently in the database.
VoteServer	voteServer() Return the VoteServer instance for this Cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHARLIMIT

public static final int CHARLIMIT

Maximum length of the communication excerpt cut out of the message body.

See Also:

Constant Field Values

Method Detail

init

public static HarvestCache init(VoteServer.Run vsRun)

The cache needs access to a VoteServer.Run and must be initialized before usage.

i

public static HarvestCache i()

Implemented as singleton.

getDatabase

public Database getDatabase()

Access the database of this HarvestCache instance. This can be used initialize other services with this db internally, so you only have to setup HarvestCache once and all services have access to the db.

Returns:

db

voteServer

public VoteServer voteServer()

Return the VoteServer instance for this Cache.

check

public boolean check(MessageContext mc,
            Authenticator av)

TODO Examine the message for difference-urls and return whether this message contains valid difference information. This includes search for difference-urls, comparing the message sender to author and candidate of the difference and verifying that the used forum is linked on the candidate's position page. Use this method in detectors to decide whether to raise a UpdateKick.

Parameters:

mc - Context of the message to check.

av - Verifier for forum identities.

Returns:

List of DraftPairs encountered or an empty list.

store

public boolean store(Message msg,
            Authenticator av)

Call this once you have a valid message including url to the web, to store it permanently in the database. This is the main public API call which processes messages:

1. Separate each DiffMessage for each Url
2. Authenticate message to AuthDiffMessage
3. TODO store relation in RelAuthDiffMessage
4. Store message with DiffMessageTable

Parameters:

msg - Message to process.

av - Verifier for this communication medium's identities.

Returns:

False if any of the steps failed.

getTable

public DiffMessageTable getTable()

Access this table to DiffMessageTable.get(String, String[], int) messages.

findDiffUrls

public List<String> findDiffUrls(String searchedString)

Lists all interesting difference-urls. Interest is determined by the difference patterns configured for this cache.

Parameters:

searchedString - Message body or content to search.

Returns:

A list of matched difference URLs.

See Also:

expandDiffMessages(Message), diffPatterns

relation

public XCastRelation relation(String author,
                     String addressee,
                     String pollName)

TODO was private, privatize again when vote history is available. Used by votorola/s/wap/HarvestWAP.java for now.

Parameters:

author -

addressee -

pollName -

Returns:

current relation between author and addressee