ReferenceField (Speedment - Build - Runtime Deploy 3.1.9 API)

Type Parameters:

ENTITY - the entity type

D - the database type

V - the field value type

All Superinterfaces:

Field<ENTITY>, HasGetter<ENTITY>, HasIdentifier<ENTITY>, HasMapToDoubleIfPresent<ENTITY,ToDoubleFunction<V>>, HasReferenceOperators<ENTITY>, HasReferenceValue<ENTITY,D,V>, HasSetter<ENTITY>, HasTypeMapper

All Known Subinterfaces:

ComparableField<ENTITY,D,V>, ComparableForeignKeyField<ENTITY,D,V,FK>, EnumField<ENTITY,D,E>, EnumForeignKeyField<ENTITY,D,E,FK>, StringField<ENTITY,D>, StringForeignKeyField<ENTITY,D,FK_ENTITY>
```
public interface ReferenceField<ENTITY,D,V>
extends Field<ENTITY>, HasReferenceOperators<ENTITY>, HasReferenceValue<ENTITY,D,V>, HasMapToDoubleIfPresent<ENTITY,ToDoubleFunction<V>>
```
A field that represents an object value.

Since:

2.2.0

Author:

Per Minborg, Emil Forslund

See Also:

Field, HasReferenceOperators, HasReferenceValue

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default ToBigDecimalNullable<ENTITY>`	`asBigDecimal()` Returns an `ToBigDecimalNullable` expression that has the value of this field but casted to a `BigDecimal`.
`default ToBooleanNullable<ENTITY>`	`asBoolean()` Returns an `ToBooleanNullable` expression that has the value of this field, casted to a `boolean` by first casting it to `Boolean`.
`default ToByteNullable<ENTITY>`	`asByte()` Returns an `ToByteNullable` expression that has the value of this field, casted to a `byte` by first casting it to `Number` and then invoking `Number.byteValue()`.
`default ToCharNullable<ENTITY>`	`asChar()` Returns an `ToCharNullable` expression that has the value of this field, casted to a `char` by first casting it to `Number` and then invoking `Number.intValue()` and casting it to a `char`.
`default ToDoubleNullable<ENTITY>`	`asDouble()` Returns an `ToDoubleNullable` expression that has the value of this field, casted to a `double` by first casting it to `Number` and then invoking `Number.doubleValue()`.
`default <E extends Enum<E>> ToEnumNullable<ENTITY,E>`	`asEnum(Class<E> enumClass)` Returns an `ToBooleanNullable` expression that has the value of this field, casted to a particular `enum` class.
`default ToFloatNullable<ENTITY>`	`asFloat()` Returns an `ToFloatNullable` expression that has the value of this field, casted to a `float` by first casting it to `Number` and then invoking `Number.floatValue()`.
`default ToIntNullable<ENTITY>`	`asInt()` Returns an `ToIntNullable` expression that has the value of this field, casted to a `int` by first casting it to `Number` and then invoking `Number.intValue()`.
`default ToLongNullable<ENTITY>`	`asLong()` Returns an `ToLongNullable` expression that has the value of this field, casted to a `long` by first casting it to `Number` and then invoking `Number.longValue()`.
`default ToShortNullable<ENTITY>`	`asShort()` Returns an `ToShortNullable` expression that has the value of this field, casted to a `short` by first casting it to `Number` and then invoking `Number.shortValue()`.
`default ToStringNullable<ENTITY>`	`asString()` Returns an `ToBooleanNullable` expression that has the value of this field, casted to a `boolean` by first casting it to `Boolean`.
`static <ENTITY,D,V> ReferenceField<ENTITY,D,V>`	`create(ColumnIdentifier<ENTITY> identifier, ReferenceGetter<ENTITY,V> getter, ReferenceSetter<ENTITY,V> setter, TypeMapper<D,V> typeMapper, boolean unique)` Creates a new `ReferenceField` using the default implementation.
`default ToBigDecimalNullable<ENTITY>`	`mapToBigDecimalIfPresent(Function<V,BigDecimal> mapper)` Returns an `ToStringNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToBooleanNullable<ENTITY>`	`mapToBooleanIfPresent(com.speedment.common.function.ToBooleanFunction<V> mapper)` Returns an `ToBooleanNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToByteNullable<ENTITY>`	`mapToByteIfPresent(com.speedment.common.function.ToByteFunction<V> mapper)` Returns an `ToByteNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToCharNullable<ENTITY>`	`mapToCharIfPresent(com.speedment.common.function.ToCharFunction<V> mapper)` Returns an `ToCharNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToDoubleNullable<ENTITY>`	`mapToDoubleIfPresent(ToDoubleFunction<V> mapper)` Returns an `ToDoubleNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default <E extends Enum<E>> ToEnumNullable<ENTITY,E>`	`mapToEnumIfPresent(Function<V,E> mapper, Class<E> enumClass)` Returns an `ToEnumNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToFloatNullable<ENTITY>`	`mapToFloatIfPresent(com.speedment.common.function.ToFloatFunction<V> mapper)` Returns an `ToFloatNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToIntNullable<ENTITY>`	`mapToIntIfPresent(ToIntFunction<V> mapper)` Returns an `ToIntNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToLongNullable<ENTITY>`	`mapToLongIfPresent(ToLongFunction<V> mapper)` Returns an `ToLongNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToShortNullable<ENTITY>`	`mapToShortIfPresent(com.speedment.common.function.ToShortFunction<V> mapper)` Returns an `ToShortNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`default ToStringNullable<ENTITY>`	`mapToStringIfPresent(Function<V,String> mapper)` Returns an `ToStringNullable` expression that has the value returned by the specified mapper function if the value for this field is not `null`, and otherwise `null`.
`ReferenceField<ENTITY,D,V>`	`tableAlias(String tableAlias)` Creates and returns a new Field with the provided `tableAlias`.

Methods inherited from interface com.speedment.runtime.field.trait.HasReferenceOperators
isNotNull, isNull

Methods inherited from interface com.speedment.runtime.field.trait.HasReferenceValue
get, getter, set, setter, setTo, typeMapper

Methods inherited from interface com.speedment.runtime.field.Field
isUnique, tableAlias

Methods inherited from interface com.speedment.runtime.field.trait.HasIdentifier
findColumn, identifier

- Method Detail
  - create
```
static <ENTITY,D,V> ReferenceField<ENTITY,D,V> create(ColumnIdentifier<ENTITY> identifier,
                                                      ReferenceGetter<ENTITY,V> getter,
                                                      ReferenceSetter<ENTITY,V> setter,
                                                      TypeMapper<D,V> typeMapper,
                                                      boolean unique)
```
    Creates a new ReferenceField using the default implementation.
    
    Type Parameters:
    
    ENTITY - the entity type
    
    D - the database type
    
    V - the field value type
    
    Parameters:
    
    identifier - the column that this field represents
    
    getter - method reference to the getter in the entity
    
    setter - method reference to the setter in the entity
    
    typeMapper - the type mapper that is applied
    
    unique - represented column only contains unique values
    
    Returns:
    
    the created field
  - tableAlias
```
ReferenceField<ENTITY,D,V> tableAlias(String tableAlias)
```
    Description copied from interface: Field
    
    Creates and returns a new Field with the provided tableAlias. The new Field will retain all other properties from this field except the tableAlias.
    
    Specified by:
    
    tableAlias in interface Field<ENTITY>
    
    Parameters:
    
    tableAlias - the table alias to use in the new field
    
    Returns:
    
    a new Field with the provided tableAlias
  - mapToByteIfPresent
```
default ToByteNullable<ENTITY> mapToByteIfPresent(com.speedment.common.function.ToByteFunction<V> mapper)
```
    Returns an ToByteNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asByte
```
default ToByteNullable<ENTITY> asByte()
```
    Returns an ToByteNullable expression that has the value of this field, casted to a byte by first casting it to Number and then invoking Number.byteValue().
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToShortIfPresent
```
default ToShortNullable<ENTITY> mapToShortIfPresent(com.speedment.common.function.ToShortFunction<V> mapper)
```
    Returns an ToShortNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asShort
```
default ToShortNullable<ENTITY> asShort()
```
    Returns an ToShortNullable expression that has the value of this field, casted to a short by first casting it to Number and then invoking Number.shortValue().
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToIntIfPresent
```
default ToIntNullable<ENTITY> mapToIntIfPresent(ToIntFunction<V> mapper)
```
    Returns an ToIntNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asInt
```
default ToIntNullable<ENTITY> asInt()
```
    Returns an ToIntNullable expression that has the value of this field, casted to a int by first casting it to Number and then invoking Number.intValue().
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToLongIfPresent
```
default ToLongNullable<ENTITY> mapToLongIfPresent(ToLongFunction<V> mapper)
```
    Returns an ToLongNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asLong
```
default ToLongNullable<ENTITY> asLong()
```
    Returns an ToLongNullable expression that has the value of this field, casted to a long by first casting it to Number and then invoking Number.longValue().
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToFloatIfPresent
```
default ToFloatNullable<ENTITY> mapToFloatIfPresent(com.speedment.common.function.ToFloatFunction<V> mapper)
```
    Returns an ToFloatNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asFloat
```
default ToFloatNullable<ENTITY> asFloat()
```
    Returns an ToFloatNullable expression that has the value of this field, casted to a float by first casting it to Number and then invoking Number.floatValue().
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToDoubleIfPresent
```
default ToDoubleNullable<ENTITY> mapToDoubleIfPresent(ToDoubleFunction<V> mapper)
```
    Returns an ToDoubleNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Specified by:
    
    mapToDoubleIfPresent in interface HasMapToDoubleIfPresent<ENTITY,ToDoubleFunction<V>>
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asDouble
```
default ToDoubleNullable<ENTITY> asDouble()
```
    Returns an ToDoubleNullable expression that has the value of this field, casted to a double by first casting it to Number and then invoking Number.doubleValue().
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToCharIfPresent
```
default ToCharNullable<ENTITY> mapToCharIfPresent(com.speedment.common.function.ToCharFunction<V> mapper)
```
    Returns an ToCharNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asChar
```
default ToCharNullable<ENTITY> asChar()
```
    Returns an ToCharNullable expression that has the value of this field, casted to a char by first casting it to Number and then invoking Number.intValue() and casting it to a char.
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToBooleanIfPresent
```
default ToBooleanNullable<ENTITY> mapToBooleanIfPresent(com.speedment.common.function.ToBooleanFunction<V> mapper)
```
    Returns an ToBooleanNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asBoolean
```
default ToBooleanNullable<ENTITY> asBoolean()
```
    Returns an ToBooleanNullable expression that has the value of this field, casted to a boolean by first casting it to Boolean.
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToStringIfPresent
```
default ToStringNullable<ENTITY> mapToStringIfPresent(Function<V,String> mapper)
```
    Returns an ToStringNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asString
```
default ToStringNullable<ENTITY> asString()
```
    Returns an ToBooleanNullable expression that has the value of this field, casted to a boolean by first casting it to Boolean.
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToBigDecimalIfPresent
```
default ToBigDecimalNullable<ENTITY> mapToBigDecimalIfPresent(Function<V,BigDecimal> mapper)
```
    Returns an ToStringNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Parameters:
    
    mapper - the mapper operation
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asBigDecimal
```
default ToBigDecimalNullable<ENTITY> asBigDecimal()
```
    Returns an ToBigDecimalNullable expression that has the value of this field but casted to a BigDecimal.
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - mapToEnumIfPresent
```
default <E extends Enum<E>> ToEnumNullable<ENTITY,E> mapToEnumIfPresent(Function<V,E> mapper,
                                                                        Class<E> enumClass)
```
    Returns an ToEnumNullable expression that has the value returned by the specified mapper function if the value for this field is not null, and otherwise null.
    
    Type Parameters:
    
    E - the enum type
    
    Parameters:
    
    mapper - the mapper operation
    
    enumClass - class of the enum to map to
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0
  - asEnum
```
default <E extends Enum<E>> ToEnumNullable<ENTITY,E> asEnum(Class<E> enumClass)
```
    Returns an ToBooleanNullable expression that has the value of this field, casted to a particular enum class.
    
    Type Parameters:
    
    E - the enum type
    
    Parameters:
    
    enumClass - class of the enum to map to
    
    Returns:
    
    expression for this value after mapper has been applied
    
    Since:
    
    3.1.0

Interface ReferenceField<ENTITY,D,V>

Method Summary

Methods inherited from interface com.speedment.runtime.field.trait.HasReferenceOperators

Methods inherited from interface com.speedment.runtime.field.trait.HasReferenceValue

Methods inherited from interface com.speedment.runtime.field.Field

Methods inherited from interface com.speedment.runtime.field.trait.HasIdentifier

Method Detail

create

tableAlias

mapToByteIfPresent

asByte

mapToShortIfPresent

asShort

mapToIntIfPresent

asInt

mapToLongIfPresent

asLong

mapToFloatIfPresent

asFloat

mapToDoubleIfPresent

asDouble

mapToCharIfPresent

asChar

mapToBooleanIfPresent

asBoolean

mapToStringIfPresent

asString

mapToBigDecimalIfPresent

asBigDecimal

mapToEnumIfPresent

asEnum