mam.agent
Class SearchAgent

java.lang.Object
  |
  +--java.lang.Thread
        |
        +--mam.agent.Agent
              |
              +--mam.agent.TransactionalAgent
                    |
                    +--mam.agent.SearchAgent

public class SearchAgent

extends TransactionalAgent

Description of the Class

Author:

nideffer

created October 8, 2001

Fields inherited from class mam.agent.Agent

AGENT_ACCESS_STATISTICS_TAG_NAME, AGENT_PROPERTIES_TAG_NAME, AGENT_TRAITS_TAG_NAME, ALL_AGENTS_ROUTING_TAG, DEFAULT_TAG_NAME, m_accessStatisticsGroup, m_agentProperties, m_facility, m_incomingMessageQueue, m_shutdown, m_sleepManager, ROLE_TAG_NAME

Fields inherited from class java.lang.Thread

MIN_PRIORITY, NORM_PRIORITY, MAX_PRIORITY

Constructor Summary

SearchAgent()           Constructor for the SearchAgent object

Method Summary
protected void	calculateAggregateTraits()           Description of the Method
void	finished(MessageWaiter messageWaiter)           Description of the Method
AgentTraits	getAggregateTraits()           Gets the AggregateTraits attribute of the SearchAgent object
protected String	getFirstWordWithCriteria(String source, int minimumLength)           Gets the FirstWordWithCriteria attribute of the SearchAgent object
protected Collection	getKnownIpAgentIds()           Gets the KnownIpAgentIds attribute of the SearchAgent object
void	handleDoQueryKnownAgentsMessage(AgentMessage m)           Description of the Method
void	handleDoQueryMessage(AgentMessage m)           Message: doSearch Parameters: Required: QueryPhrase: Response Message: eventSearchComplete Parameters: Required: QueryPhrase: FoundResults: Optional: IPAgents: -- of MamId, Vector where MamId references IPAgents who know about QueryPhrase Vector is a list of MamId, Integer where MamId is a KnowledgeAgent associated w/ that IPAgent Integer is that agent's relevance rating
void	handleEventAgentDeathMessage(AgentMessage m)           Description of the Method
void	handleEventDeclareAgentPropertiesMessage(AgentMessage m)           Description of the Method
void	handleEventQueryCompleteMessage(AgentMessage m)           Description of the Method
void	handleEventQueryInformationPersonaeResultsMessage(AgentMessage m)           Description of the Method
void	handleGetAggregateTraitsMessage(AgentMessage m)           Description of the Method
protected void	queryFinished(MessageWaiter messageWaiter)           Description of the Method
protected void	queryIpIteration(MessageWaiter messageWaiter, Collection recentResponses)           Description of the Method
protected void	registerRoutingTags()           Description of the Method
void	responsesReceived(MessageWaiter messageWaiter, Serializable identifier, Collection recentResponses)           Description of the Method
void	run()           Main processing method for the SearchAgent object
void	setAggregateTraits(AgentTraits oAggregateTraits)           Sets the AggregateTraits attribute of the SearchAgent object
protected void	unregisterRoutingTags()           Description of the Method

Methods inherited from class mam.agent.TransactionalAgent

enqueueMessage, getMessageWaiters

Methods inherited from class mam.agent.Agent

fromXmlElement, getAccessStatisticsGroup, getAccount, getAgentProperties, getAgentTraits, getDescription, getFacility, getMamId, getNickname, getQuote, getRole, getRoutingTagToSelf, getXmlSerializable, handleDoAgentShutdownMessage, handleGetAccessStatisticsMessage, handleGetAgentPropertiesMessage, handleGetAgentTraitsMessage, handleGetQuoteMessage, handleMessages, handleSetDescriptionMessage, handleSetNicknameMessage, idleActivity, invokeMessageHandler, requiresPersistence, setAccount, setAgentTraits, setDescription, setFacility, setMamId, setNickname, setRole, setXmlSerializable, toString, toXmlElement, toXmlElement

Methods inherited from class java.lang.Thread

currentThread, yield, sleep, sleep, start, stop, stop, interrupt, interrupted, isInterrupted, destroy, isAlive, suspend, resume, setPriority, getPriority, setName, getName, getThreadGroup, activeCount, enumerate, countStackFrames, join, join, join, dumpStack, setDaemon, isDaemon, checkAccess, getContextClassLoader, setContextClassLoader

Methods inherited from class java.lang.Object

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

Field Detail

AGGREGATE_TRAITS_CHANGE_LISTENERS_ROUTING_TAG

public final static RoutingTag AGGREGATE_TRAITS_CHANGE_LISTENERS_ROUTING_TAG

public final static double CHECK_KNOWLEDGE_PROBABILITY

protected final static String DO_QUERY_MESSAGE_WAITER

static Category Log

protected AgentTraits m_aggregateTraits

protected AgedMap m_knownIpAgents

public final static double PING_KNOWLEDGE_PROBABILITY

protected final static int PING_ROLE_NAME_SLEEP_TIME

protected final static long QUERY_TIME_OUT

protected final static long QUERY_UPDATE_PERIOD

public final static RoutingTag SEARCH_AGENTS_ROUTING_TAG

public SearchAgent()

Constructor for the SearchAgent object

Since:

protected void calculateAggregateTraits()

Description of the Method

Since:

public void finished(MessageWaiter messageWaiter)

Description of the Method

Parameters:

messageWaiter - Description of Parameter

Since:

public AgentTraits getAggregateTraits()

Gets the AggregateTraits attribute of the SearchAgent object

Returns: The AggregateTraits value

Since:

protected String getFirstWordWithCriteria(String source, int minimumLength)

Gets the FirstWordWithCriteria attribute of the SearchAgent object

Parameters:

source - Description of Parameter

minimumLength - Description of Parameter

Returns: The FirstWordWithCriteria value

Since:

protected Collection getKnownIpAgentIds()

Gets the KnownIpAgentIds attribute of the SearchAgent object

Returns: The KnownIpAgentIds value

Since:

public void handleDoQueryKnownAgentsMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleDoQueryMessage(AgentMessage m)

Message: doSearch Parameters: Required: QueryPhrase: Response Message: eventSearchComplete Parameters: Required: QueryPhrase: FoundResults: Optional: IPAgents: -- of MamId, Vector where MamId references IPAgents who know about QueryPhrase Vector is a list of MamId, Integer where MamId is a KnowledgeAgent associated w/ that IPAgent Integer is that agent's relevance rating

Parameters:

m - Description of Parameter

Since:

public void handleEventAgentDeathMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleEventDeclareAgentPropertiesMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleEventQueryCompleteMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleEventQueryInformationPersonaeResultsMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

public void handleGetAggregateTraitsMessage(AgentMessage m)

Description of the Method

Parameters:

m - Description of Parameter

Since:

protected void queryFinished(MessageWaiter messageWaiter)

Description of the Method

Parameters:

messageWaiter - Description of Parameter

Since:

protected void queryIpIteration(MessageWaiter messageWaiter, Collection recentResponses)

Description of the Method

Parameters:

messageWaiter - Description of Parameter

recentResponses - Description of Parameter

Since:

protected void registerRoutingTags()

Description of the Method

Since:

public void responsesReceived(MessageWaiter messageWaiter, Serializable identifier, Collection recentResponses)

Description of the Method

Parameters:

messageWaiter - Description of Parameter

identifier - Description of Parameter

recentResponses - Description of Parameter

Since:

public void run()

Main processing method for the SearchAgent object

Since:

public void setAggregateTraits(AgentTraits oAggregateTraits)

Sets the AggregateTraits attribute of the SearchAgent object

Parameters:

oAggregateTraits - The new AggregateTraits value

Since:

protected void unregisterRoutingTags()

Description of the Method

Since: