Package org.infinispan.lucene

Class FileCacheKey

java.lang.Object

org.infinispan.lucene.FileCacheKey

All Implemented Interfaces:

AffinityTaggedKey, IndexScopedKey

public final class FileCacheKey
extends Object
implements IndexScopedKey

Used as a key for file headers in a cache

Since:

4.0

Author:

Lukasz Moren, Sanne Grinovero

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileCacheKey.Externalizer

Constructor Summary

Constructors

Constructor	Description
FileCacheKey(String indexName, String fileName, int affinitySegmentId)

Method Summary

Modifier and Type	Method	Description
Object	accept(KeyVisitor visitor)
boolean	equals(Object obj)
int	getAffinitySegmentId()	This numeric id is used exclusively for storage affinity in Infinispan.
String	getFileName()	Get the fileName.
String	getIndexName()	Get the indexName.
int	hashCode()
String	toString()	Changing the encoding could break backwards compatibility

Methods inherited from class java.lang.Object

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

Constructor Detail

FileCacheKey

public FileCacheKey(String indexName,
                    String fileName,
                    int affinitySegmentId)

Method Detail

getIndexName

public String getIndexName()

Get the indexName.

Specified by:

getIndexName in interface IndexScopedKey

Returns:

the indexName.

getAffinitySegmentId

public int getAffinitySegmentId()

Description copied from interface: IndexScopedKey

This numeric id is used exclusively for storage affinity in Infinispan. It is not included in the equals and hashcode implementations!

Specified by:

getAffinitySegmentId in interface AffinityTaggedKey

Specified by:

getAffinitySegmentId in interface IndexScopedKey

Returns:

the segment id as defined in BuildContext.affinityLocationIntoSegment(int), or -1 when not explicitly set.

accept

public Object accept(KeyVisitor visitor)
              throws Exception

Specified by:

accept in interface IndexScopedKey

Throws:

Exception

getFileName

public String getFileName()

Get the fileName.

Returns:

the fileName.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Changing the encoding could break backwards compatibility

Overrides:

toString in class Object

See Also:

LuceneKey2StringMapper.getKeyMapping(String)