com.goldencode.p2j.persist

Class UniqueIndexLookup

java.lang.Object

com.goldencode.p2j.persist.UniqueIndexLookup

public class UniqueIndexLookup
extends java.lang.Object

Utility class which stores the properties and values of a look-up which is done over an unique index.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	properties The properties of the unique index, not necessarily in order
private java.util.List<java.lang.Object>	values The values used for look-up; the order matched the order of the properties A null value means a value that is provided latter (by substitution parameters).

Constructor Summary

Constructors

Constructor and Description
UniqueIndexLookup() Basic constructor
UniqueIndexLookup(UniqueIndexLookup prototype) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	addMapping(java.lang.String property, java.lang.Object value) Add a new property-value mapping to this look-up.
boolean	fill(java.lang.Object[] fillValues) Fill the null values from the values array with the provided fill values.
java.lang.String[]	getProperties() Retrieve the properties as an array.
java.lang.Object[]	getValues() Retrieve the values as an array.

Methods inherited from class java.lang.Object

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

Field Detail

properties

private java.util.List<java.lang.String> properties

The properties of the unique index, not necessarily in order

values

private java.util.List<java.lang.Object> values

The values used for look-up; the order matched the order of the properties A null value means a value that is provided latter (by substitution parameters).

Constructor Detail

UniqueIndexLookup

public UniqueIndexLookup()

Basic constructor

UniqueIndexLookup

public UniqueIndexLookup(UniqueIndexLookup prototype)

Copy constructor

Parameters:

prototype - The prototype to be used when building this object.

Method Detail

fill

public boolean fill(java.lang.Object[] fillValues)

Fill the null values from the values array with the provided fill values. This is used to lazily add the substitution parameters when needed.

Parameters:

fillValues - The values to be used when filling the parameters array.

Returns:

true if the filling succeeded. If this returns false, the object reaches a stale state, so avoid using it.

addMapping

public void addMapping(java.lang.String property,
                       java.lang.Object value)

Add a new property-value mapping to this look-up.

Parameters:

property - The property from an unique index.

value - The value to be used when doing look-up.

getProperties

public java.lang.String[] getProperties()

Retrieve the properties as an array.

Returns:

The array of properties.

getValues

public java.lang.Object[] getValues()

Retrieve the values as an array.

Returns:

The array of values.