sirius.db.mixing

Class AccessPath

java.lang.Object

sirius.db.mixing.AccessPath

public class AccessPath
extends Object

Determines how to access the field of a property within the entity.

As properties can be contained within composites or mixins (or a combination thereof) we may need to fetch the composite or use Composable.as(Class) to fetch the mixin in order to access the field. The types and number of calls are defined by an AccessPath.

Field Summary

Fields

Modifier and Type	Field and Description
static AccessPath	IDENTITY Represents a NO-OP access path which is used for all fields which are directly contained in the entity.

Constructor Summary

Constructors

Constructor and Description
AccessPath()

Method Summary

Modifier and Type	Method and Description
AccessPath	append(String prefix, Function<Object,Object> accessor) Creates a new access path which appends the given prefix and accessor to the current access path.
Object	apply(Object object) Applies the access path of the given object.
String	prefix() Returns the prefix appended to all fields to generate unique property names.

Methods inherited from class java.lang.Object

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

Field Detail

IDENTITY

public static final AccessPath IDENTITY

Represents a NO-OP access path which is used for all fields which are directly contained in the entity.

Constructor Detail

AccessPath

public AccessPath()

Method Detail

append

@Nonnull
public AccessPath append(@Nonnull
                                  String prefix,
                                  @Nonnull
                                  Function<Object,Object> accessor)

Creates a new access path which appends the given prefix and accessor to the current access path.

Parameters:

prefix - the prefix to be appended to all field names to make them unique (composites might be embedded twice).

accessor - the function used to access the sub entity (composite or mixin) from the current access path

Returns:

a new access path which is extended by the given prefix and accessor

apply

@Nonnull
public Object apply(@Nonnull
                             Object object)

Applies the access path of the given object.

Applies all accessor functions one after another to extract the object containing a property from the given root object.

Parameters:

object - the root object from which the designated target object (composite or mixin) is to be extracted

Returns:

the designated target which contains the field of a property (a composite or mixin)

prefix

public String prefix()

Returns the prefix appended to all fields to generate unique property names.

Returns:

the prefix used to represent this access path