com.vordel.es.xes

Class PortableESPK

java.lang.Object

com.vordel.es.xes.PortableESPK

All Implemented Interfaces:

com.vordel.common.Dictionary, ESPK, java.lang.Comparable<PortableESPK>

public class PortableESPK
extends java.lang.Object
implements ESPK, java.lang.Comparable<PortableESPK>, com.vordel.common.Dictionary

Implementation of a portable or 'provider-neutral' ESPK. This ESPK can be used to identify specific Entities in any given entity store, based on their key field values. It is used specifically for importing/exporting data and for comparing Entities between two stores.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PortableESPK.KeyNode
static class	PortableESPK.NVPair

Nested classes/interfaces inherited from interface com.vordel.common.Dictionary

com.vordel.common.Dictionary.MapAs

Field Summary

Fields

Modifier and Type	Field and Description
protected static PortableESPK.KeyNode	NULL_KEY_NODE
static PortableESPK	ROOT_KEY
protected static PortableESPK.KeyNode	ROOT_KEY_NODE
protected PortableESPK.KeyNode	topNode

Fields inherited from interface com.vordel.common.Dictionary

empty

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PortableESPK(PortableESPK.KeyNode node)

Method Summary

Modifier and Type	Method and Description
int	compareTo(PortableESPK o)
boolean	equals(java.lang.Object other) Although the Object class in java guarantees the equals method, capture it here for completeness
java.lang.Object	get(java.lang.String key)
java.lang.String	getEntityKeyString()
java.lang.String	getFieldValueOfReferencedEntity(java.lang.String field)
java.util.List<PortableESPK.NVPair>	getFieldValuesOfReferencedEntity()
PortableESPK	getParentPK()
java.lang.String	getTypeNameOfReferencedEntity()
int	hashCode() Although the Object class in java guarantees the hashCode method, capture it here for completeness
PortableESPK	reroot(PortableESPK newPPK)
void	serialize(java.io.Writer w)
java.lang.String	terse() A human readble, non-canonical, pretty version of the portable key - no types, no key attributes.
static PortableESPK	toPortableKey(EntityStore es, ESPK pk)
java.lang.String	toShorthandString()
java.lang.String	toString() Retrieve a string representation of the key.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_KEY_NODE

protected static final PortableESPK.KeyNode ROOT_KEY_NODE

NULL_KEY_NODE

protected static final PortableESPK.KeyNode NULL_KEY_NODE

ROOT_KEY

public static final PortableESPK ROOT_KEY

topNode

protected PortableESPK.KeyNode topNode

Constructor Detail

PortableESPK

protected PortableESPK(PortableESPK.KeyNode node)

Method Detail

getTypeNameOfReferencedEntity

public java.lang.String getTypeNameOfReferencedEntity()

getFieldValuesOfReferencedEntity

public java.util.List<PortableESPK.NVPair> getFieldValuesOfReferencedEntity()

getFieldValueOfReferencedEntity

public java.lang.String getFieldValueOfReferencedEntity(java.lang.String field)

hashCode

public int hashCode()

Description copied from interface: ESPK

Although the Object class in java guarantees the hashCode method, capture it here for completeness

Specified by:

hashCode in interface ESPK

Overrides:

hashCode in class java.lang.Object

Returns:

A hashcode for the key

equals

public boolean equals(java.lang.Object other)

Description copied from interface: ESPK

Although the Object class in java guarantees the equals method, capture it here for completeness

Specified by:

equals in interface ESPK

Overrides:

equals in class java.lang.Object

Returns:

True if this key equals another one, false otherwise

toShorthandString

public java.lang.String toShorthandString()

getEntityKeyString

public java.lang.String getEntityKeyString()

terse

public java.lang.String terse()

A human readble, non-canonical, pretty version of the portable key - no types, no key attributes.

Returns:

A String describing the key.

getParentPK

public PortableESPK getParentPK()

serialize

public void serialize(java.io.Writer w)
               throws java.io.IOException

Throws:

java.io.IOException

compareTo

public int compareTo(PortableESPK o)

Specified by:

compareTo in interface java.lang.Comparable<PortableESPK>

toString

public java.lang.String toString()

Description copied from interface: ESPK

Retrieve a string representation of the key.

Specified by:

toString in interface ESPK

Overrides:

toString in class java.lang.Object

Returns:

A String encoding of the key.

get

public java.lang.Object get(java.lang.String key)

Specified by:

get in interface com.vordel.common.Dictionary

toPortableKey

public static PortableESPK toPortableKey(EntityStore es,
                                         ESPK pk)

reroot

public PortableESPK reroot(PortableESPK newPPK)