sirius.db.mixing

Class Mapping

java.lang.Object

sirius.db.mixing.Mapping

public class Mapping
extends Object

Represents a column (property) name which is used in queries.

For each field, a Mapping with the same name must be defined. This mapping is used to reference the field (or its property) in queries. This adds syntactic checks and permits refactorings (renaming etc.).

An example for a field with its mapping would be:

 
    public static final Mapping AGE = Mapping.named("age");
    private int age;
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	NESTED_SEPARATOR Used to join several field names (e.g. for nesteds).
static String	SUBFIELD_SEPARATOR Used to join several field names (e.g. for composites or mixins).

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the field name for which this mapping was created.
Mapping	getParent() Returns the parent field.
Mapping	inMixin(Class<?> mixinType) References a mixin for an inner composite or referenced type.
Mapping	inner(Mapping inner) References an inner field of a composite represented by this mapping.
Mapping	join(Mapping joinMapping) Joins the referenced field described by joinMapping.
static Mapping	mixin(Class<?> mixinType) Creates a new Mapping for a mixin class.
static Mapping	named(String name) Creates a new Mapping.
Mapping	nested(Mapping inner) References a field of a nested list or map represented by this mapping.
Mapping	nested(String inner) References a dynamic inner property of a nested map represented by this mapping.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUBFIELD_SEPARATOR

public static final String SUBFIELD_SEPARATOR

Used to join several field names (e.g. for composites or mixins).

See Also:

Constant Field Values

NESTED_SEPARATOR

public static final String NESTED_SEPARATOR

Used to join several field names (e.g. for nesteds).

See Also:

Constant Field Values

Method Detail

named

public static Mapping named(String name)

Creates a new Mapping. This should be used to create a public static final constant in the class where the field is defined.

Parameters:

name - the name of the represented field

Returns:

a mapping representing the field with the given name

mixin

public static Mapping mixin(Class<?> mixinType)

Creates a new Mapping for a mixin class.

Parameters:

mixinType - the class which defines the mixin

Returns:

a mapping representing the mixin

inner

public Mapping inner(Mapping inner)

References an inner field of a composite represented by this mapping.

Parameters:

inner - the inner field of the composite represented by this mapping

Returns:

a mapping representing the combined path of this mapping and inner field

nested

public Mapping nested(Mapping inner)

References a field of a nested list or map represented by this mapping.

This is the equivalent of join(Mapping) for NOSQL databases like Elasticsearch or Mongo DB.

Parameters:

inner - the inner field of the nested represented by this mapping

Returns:

a mapping representing the combined path of this mapping and inner field

nested

public Mapping nested(String inner)

References a dynamic inner property of a nested map represented by this mapping.

This is the equivalent of join(Mapping) for NOSQL databases like Elasticsearch or Mongo DB.

Parameters:

inner - the inner field of the nested represented by this mapping

Returns:

a mapping representing the combined path of this mapping and inner field

inMixin

public Mapping inMixin(Class<?> mixinType)

References a mixin for an inner composite or referenced type.

Parameters:

mixinType - t the class which defines the mixin

Returns:

a mapping representing the combined path of this mapping and the given mixin

join

public Mapping join(Mapping joinMapping)

Joins the referenced field described by joinMapping.

Note that this mapping needs to represent an EntityRef field.

Parameters:

joinMapping - the mapping of the referenced entity to join

Returns:

a mapping which joins the entity represented by this mapping and accesses the given joinMapping

getName

public String getName()

Returns the field name for which this mapping was created.

Note that this is not necessarily the property name as for properties in mixins or compounds, the parent fields are appended separated by SUBFIELD_SEPARATOR.

Returns:

the field name for which this mapping was created

getParent

@Nullable
public Mapping getParent()

Returns the parent field.

Returns:

the parent field (the composite or mixin which contains this mapping). Returns null if this is a top-level field of an entity

toString

public String toString()

Overrides:

toString in class Object