public class StoreKey extends java.lang.Object implements NumericKey, XMLizable, com.ibm.websphere.cache.Sizeable
StoreKey
defines the key for a Store
External
Entity. The Key uniquely identifies the Store
entity. A
Distinguished Name DN
and a store Identifier
form the key for Store
entity.
XML Snippet for StoreKey:
<StoreKey> <DN>ou=b2c,o=seller organization,o=root organization</DN> <Identifier>ConsumerDirect</Identifier> </StoreKey>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
static StoreKey |
NULL_ENTITY_STORE_KEY
A wildcard store key
|
Constructor and Description |
---|
StoreKey()
Default Constructor for StoreKey.
|
StoreKey(java.lang.String aDN,
java.lang.String aIdentifier)
Constructor for StoreKey.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Returns true if this Store key equals to another Store key.
|
void |
fromXML(org.w3c.dom.Node node)
Transforms the XML node into its corresponding real Object.
|
java.lang.String |
getDN()
Returns the
DN of store key. |
java.lang.String |
getIdentifier()
Returns the Identifier of store key.
|
java.lang.Number |
getNumericKey()
Returns the numericKey.
|
long |
getObjectSize()
Returns the estimated footprint size in bytes
of this object and the objects it contains.
|
int |
hashCode()
Returns the hashcode of the Store key.
|
boolean |
isNumericKeySet()
Checks if numericKey is set or not.
|
void |
setDN(java.lang.String aDN)
Sets the
DN of store key. |
void |
setIdentifier(java.lang.String aIdentifier)
Sets the
Identifier of store key. |
void |
setNumericKey(java.lang.Number aNumericKey)
Sets the numericKey.
|
java.lang.String |
toString()
Give a String presentation of this Store Key.
|
java.lang.String |
toXML()
Converts the object into its corresponding XML format representation.
|
public static final java.lang.String COPYRIGHT
public static final StoreKey NULL_ENTITY_STORE_KEY
public StoreKey()
public StoreKey(java.lang.String aDN, java.lang.String aIdentifier)
aDN
- java.lang.String is DN of store key.aIdentifier
- java.lang.String is the identifier of the store key.public long getObjectSize()
getObjectSize
in interface com.ibm.websphere.cache.Sizeable
public java.lang.String getDN()
DN
of store key.DN
of store key.public void setDN(java.lang.String aDN)
DN
of store key.aDN
- The DN to set.public void setIdentifier(java.lang.String aIdentifier)
Identifier
of store key.aIdentifier
- The Identifier to set.public java.lang.String getIdentifier()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- Object
is another store key.true
if keys are equal;
false
otherwise.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.Number getNumericKey()
getNumericKey
in interface NumericKey
public boolean isNumericKeySet()
isNumericKeySet
in interface NumericKey
true
if key is set;
false
otherwise.public void setNumericKey(java.lang.Number aNumericKey)
aNumericKey
- The numericKey to setpublic void fromXML(org.w3c.dom.Node node) throws DeXMLizationException
XMLizable
fromXML
in interface XMLizable
node
- The node that represents an XMLizable objectDeXMLizationException
- when this process failsXMLizable.fromXML(Node)
public java.lang.String toXML() throws XMLizationException
XMLizable
toXML
in interface XMLizable
XMLizationException
- when this process failsXMLizable.toXML()