sirius.db.mixing

Class Mixing

java.lang.Object

sirius.db.mixing.Mixing

All Implemented Interfaces:

sirius.kernel.di.Initializable

public class Mixing
extends Object
implements sirius.kernel.di.Initializable

Provides a lookup facility to the descriptor for an entity.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REALM Contains the name of the default realm.
static sirius.kernel.health.Log	LOG

Constructor Summary

Constructors

Constructor and Description
Mixing()

Method Summary

Modifier and Type	Method and Description
Optional<EntityDescriptor>	findDescriptor(String aTypeName) Returns the descriptor for the given entity type.
Collection<EntityDescriptor>	getDesciptors() Returns all known descriptors.
EntityDescriptor	getDescriptor(Class<?> aClass) Returns the descriptor of the given entity class.
EntityDescriptor	getDescriptor(String aTypeName) Returns the descriptor for the given entity type.
String	getNameForType(Class<?> type) Each entity type can be addressed by its class or by a unique name, which is its simple class name in upper case.
String	getUniqueName(Class<?> type, Object id) Computes the unique name of an entity based on its type and id.
String	getUniqueName(String typeName, Object id) Computes the unique name of an entity based on its descriptor type and id.
void	initialize()
static sirius.kernel.commons.Tuple<String,String>	splitUniqueName(String uniqueName) Splits a unique name into the descriptor type and id.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REALM

public static final String DEFAULT_REALM

Contains the name of the default realm.

See Also:

Constant Field Values

LOG

public static final sirius.kernel.health.Log LOG

Constructor Detail

Mixing

public Mixing()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface sirius.kernel.di.Initializable

Throws:

Exception

getNameForType

@Nonnull
public String getNameForType(@Nonnull
                                      Class<?> type)

Each entity type can be addressed by its class or by a unique name, which is its simple class name in upper case.

Parameters:

type - the entity class to generate the type name for

Returns:

the type name of the given type

getUniqueName

@Nonnull
public String getUniqueName(@Nonnull
                                     String typeName,
                                     Object id)

Computes the unique name of an entity based on its descriptor type and id.

Parameters:

typeName - the name of the entity type

id - the id of the entity

Returns:

a unique name consisting of the typeName and id

getUniqueName

@Nonnull
public String getUniqueName(@Nonnull
                                     Class<?> type,
                                     Object id)

Computes the unique name of an entity based on its type and id.

Parameters:

type - the entity class to generate the type name for

id - the id of the entity

Returns:

a unique name consisting of the typeName and id

splitUniqueName

@Nonnull
public static sirius.kernel.commons.Tuple<String,String> splitUniqueName(@Nullable
                                                                                  String uniqueName)

Splits a unique name into the descriptor type and id.

Parameters:

uniqueName - the unique name of an entity.

Returns:

the type and id of the entity as tuple

See Also:

getUniqueName(String, Object)

getDescriptor

public EntityDescriptor getDescriptor(Class<?> aClass)

Returns the descriptor of the given entity class.

Parameters:

aClass - the entity class

Returns:

the descriptor of the given entity class

getDescriptor

public EntityDescriptor getDescriptor(String aTypeName)

Returns the descriptor for the given entity type.

Parameters:

aTypeName - a getNameForType(Class) of an entity

Returns:

the descriptor for the given type name

Throws:

sirius.kernel.health.HandledException - if no matching descriptor exists

findDescriptor

public Optional<EntityDescriptor> findDescriptor(String aTypeName)

Returns the descriptor for the given entity type.

Parameters:

aTypeName - a getNameForType(Class) of an entity

Returns:

the descriptor for the given type name as optional

getDesciptors

public Collection<EntityDescriptor> getDesciptors()

Returns all known descriptors.

Returns:

an unmodifyable list of all known descriptors