org.apache.manifoldcf.crawler.jobs

Class Jobs.JobObjectDescription

java.lang.Object

org.apache.manifoldcf.core.cachemanager.BaseDescription

org.apache.manifoldcf.crawler.jobs.Jobs.JobObjectDescription

All Implemented Interfaces:

ICacheDescription

Enclosing class:

Jobs

protected static class Jobs.JobObjectDescription
extends BaseDescription

Job object description class. This class describes an object in the cache.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.manifoldcf.core.cachemanager.BaseDescription

BaseDescription.LocalCacheClass

Field Summary

Fields

Modifier and Type	Field and Description
protected StringSet	cacheKeys
protected java.lang.String	criticalSectionName
protected java.lang.Long	jobID

Fields inherited from class org.apache.manifoldcf.core.cachemanager.BaseDescription

_rcsid, cacheClass, MAX_VALUE

Constructor Summary

Constructors

Constructor and Description
JobObjectDescription(java.lang.Long jobID, StringSet invKeys)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getCriticalSectionName() Get the critical section name for this description object.
java.lang.Long	getJobID()
StringSet	getObjectKeys() Get the cache keys for an object (which may or may not exist yet in the cache).
int	hashCode()

Methods inherited from class org.apache.manifoldcf.core.cachemanager.BaseDescription

getObjectClass, getObjectExpirationTime

Methods inherited from class java.lang.Object

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

Field Detail

jobID

protected java.lang.Long jobID

criticalSectionName

protected java.lang.String criticalSectionName

cacheKeys

protected StringSet cacheKeys

Constructor Detail

JobObjectDescription

public JobObjectDescription(java.lang.Long jobID,
                            StringSet invKeys)

Method Detail

getJobID

public java.lang.Long getJobID()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getCriticalSectionName

public java.lang.String getCriticalSectionName()

Description copied from interface: ICacheDescription

Get the critical section name for this description object. This is used to synchronize creation of the described object, and thus is used only for objects that will be cached. This method does not need to return decent results for objects that are never cached.

Returns:

the critical section name.

getObjectKeys

public StringSet getObjectKeys()

Get the cache keys for an object (which may or may not exist yet in the cache). This method is called in order for cache manager to throw the correct locks.

Returns:

the object's cache keys, or null if the object should not be cached.