org.jminor.framework.domain

Interface Entity.Key

All Superinterfaces:

java.io.Serializable, ValueCollectionProvider<java.lang.Object>, ValueMap<ColumnProperty,java.lang.Object>, ValueProvider<ColumnProperty,java.lang.Object>

Enclosing interface:

Entity

public static interface Entity.Key
extends ValueMap<ColumnProperty,java.lang.Object>, java.io.Serializable

A class representing a primary key.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.common.db.valuemap.ValueMap

ValueMap.Validator<K,V extends ValueMap<K,?>>

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String propertyId)
java.lang.String	getEntityId()
ColumnProperty	getFirstProperty()
java.lang.Object	getFirstValue()
java.util.List<ColumnProperty>	getProperties()
int	getPropertyCount()
boolean	isCompositeKey()
boolean	isNotNull(java.lang.String propertyId) Returns true if a non-null value is mapped to the given property.
boolean	isNull()
boolean	isNull(java.lang.String propertyId) Returns true if a null value is mapped to the given property or no mapping exists.
boolean	isSingleIntegerKey()
java.lang.Object	put(java.lang.String propertyId, java.lang.Object value)

Methods inherited from interface org.jminor.common.db.valuemap.ValueMap

addValueListener, clear, containsKey, getAsString, getCopy, getModifiedObserver, getOriginal, getOriginalCopy, getValueObserver, isModified, isModified, isNotNull, isNull, keySet, newInstance, originalKeySet, put, remove, removeValueListener, revert, revertAll, save, saveAll, setAs, size

Methods inherited from interface org.jminor.common.db.valuemap.ValueProvider

get

Methods inherited from interface org.jminor.common.db.valuemap.ValueCollectionProvider

values

Method Detail

getEntityId

java.lang.String getEntityId()

Returns:

the entity ID

getProperties

java.util.List<ColumnProperty> getProperties()

Returns:

a List containing the properties comprising this key

getPropertyCount

int getPropertyCount()

Returns:

the number of properties comprising this key

isNull

boolean isNull()

Returns:

true if this key contains no values or if it contains a null value for a non-nullable key property

isNull

boolean isNull(java.lang.String propertyId)

Returns true if a null value is mapped to the given property or no mapping exists.

Parameters:

propertyId - the propertyId

Returns:

true if the value mapped to the given property is null or none exists

isNotNull

boolean isNotNull(java.lang.String propertyId)

Returns true if a non-null value is mapped to the given property.

Parameters:

propertyId - the propertyId

Returns:

true if a non-null value is mapped to the given property

isSingleIntegerKey

boolean isSingleIntegerKey()

Returns:

true if this primary key is based on a single integer column

isCompositeKey

boolean isCompositeKey()

Returns:

true if this key is comprised of multiple properties.

getFirstProperty

ColumnProperty getFirstProperty()

Returns:

the first key property, useful for single property keys

getFirstValue

java.lang.Object getFirstValue()

Returns:

the first value contained in this key, useful for single property keys

put

java.lang.Object put(java.lang.String propertyId,
                     java.lang.Object value)

Parameters:

propertyId - the propertyId

value - the value to associate with the property

Returns:

the previous value

get

java.lang.Object get(java.lang.String propertyId)

Parameters:

propertyId - the propertyId

Returns:

the value associated with the given property