org.jboss.cache.search
Class CacheEntityId

java.lang.Object
  org.jboss.cache.search.CacheEntityId

public class CacheEntityId
extends Object

This class is used to get fqns, keys and documentId's by calling methods on Transformer

Author:

Navin Surtani (nsurtani@redhat.com)

Constructor Summary

CacheEntityId(org.jboss.cache.Fqn fqn, String key)

CacheEntityId(String documentId)

Method Summary

String	getDocumentId() Gets a documentId String from an Fqn and key combination.
org.jboss.cache.Fqn	getFqn() Gets the Fqn from the instance of CacheEntityId.
String	getKey() Gets the key from the instance of CacheEntityId.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheEntityId

public CacheEntityId(String documentId)

CacheEntityId

public CacheEntityId(org.jboss.cache.Fqn fqn,
                     String key)

Method Detail

getFqn

public org.jboss.cache.Fqn getFqn()

Gets the Fqn from the instance of CacheEntityId.

Returns:

Fqn from the instance of CacheEntityId.

getKey

public String getKey()

Gets the key from the instance of CacheEntityId.

Returns:

Key from the instance of CacheEntityId.

getDocumentId

public String getDocumentId()
                     throws InvalidKeyException

Gets a documentId String from an Fqn and key combination.

Returns:

documentId String.

Throws:

InvalidKeyException