er.neo4jadaptor.ersatz

Class Ersatz

java.lang.Object

er.neo4jadaptor.ersatz.Ersatz

Direct Known Subclasses:

LuceneErsatz, Neo4JErsatz, NSDictionaryErsatz

public abstract class Ersatz
extends Object

Neutral form for communication with various forms of EO object storages. Single Ersatz instance represents one record. It's a form of map, where keys are EO attributes, values are neutral java types (see package description) and if some key is not set then this value is not present.

It contains values only for EO attributes returned in attributes() method. Values for all other attributes are assumed to be empty.

Author:

Jedrzej Sobanski

Field Summary

Fields

Modifier and Type	Field and Description
static Ersatz	EMPTY Empty ersatz object with no attributes set.

Constructor Summary

Constructors

Constructor and Description
Ersatz()

Method Summary

Modifier and Type	Method and Description
abstract Iterable<EOAttribute>	attributes() Gets all EO attributes that this ersatz object has values stored for.
static void	copy(Ersatz source, Ersatz dest) Copy all EO attributes defined in source object to the destination
abstract void	delete() Delete record that this ersatz represents.
abstract Object	get(EOAttribute att) Gets neutral value for an EO attribute.
abstract void	put(EOAttribute att, Object value) Sets neutral java value for an EO attribute.
abstract void	remove(EOAttribute att) Clears value for an EO attribute.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Ersatz EMPTY

Empty ersatz object with no attributes set.

Constructor Detail

Ersatz

public Ersatz()

Method Detail

get

public abstract Object get(EOAttribute att)

Gets neutral value for an EO attribute. It's not defined what implementations should do when given attribute that's not in attributes().

Parameters:

att - EO attribute to retrieve value for

Returns:

neutral java value if attribute is known

put

public abstract void put(EOAttribute att,
                         Object value)

Sets neutral java value for an EO attribute.

Parameters:

att - EO attribute to set the value for

value - library independent value

remove

public abstract void remove(EOAttribute att)

Clears value for an EO attribute.

Parameters:

att -

attributes

public abstract Iterable<EOAttribute> attributes()

Gets all EO attributes that this ersatz object has values stored for.

Returns:

EO attributes that it has values for

copy

public static void copy(Ersatz source,
                        Ersatz dest)

Copy all EO attributes defined in source object to the destination

Parameters:

source - object to copy from

dest - object to copy to

delete

public abstract void delete()

Delete record that this ersatz represents.