com.datastax.oss.driver.api.mapper

Interface MapperContext

public interface MapperContext

A runtime context that gets passed from the mapper to DAO components to share global resources and configuration.

Method Summary

Modifier and Type	Method and Description
Map<Object,Object>	getCustomState() Retrieves any custom state that was set while building the mapper with MapperBuilder.withCustomState(Object, Object).
DriverExecutionProfile	getExecutionProfile() If this context belongs to a DAO that was built with a method that takes an execution profile as parameter, the value of that parameter.
String	getExecutionProfileName() If this context belongs to a DAO that was built with a method that takes an execution profile name as parameter, the value of that parameter.
CqlIdentifier	getKeyspaceId() If this context belongs to a DAO that was built with a keyspace-parameterized mapper method, the value of that parameter.
NameConverter	getNameConverter(Class<? extends NameConverter> converterClass) Returns an instance of the given converter class.
MapperResultProducer	getResultProducer(GenericType<?> resultToProduce) Returns a component that will execute a statement and convert it into a custom result of the given type.
CqlSession	getSession()
CqlIdentifier	getTableId() If this context belongs to a DAO that was built with a table-parameterized mapper method, the value of that parameter.

Method Detail

getSession

@NonNull
CqlSession getSession()

getKeyspaceId

@Nullable
CqlIdentifier getKeyspaceId()

If this context belongs to a DAO that was built with a keyspace-parameterized mapper method, the value of that parameter. Otherwise null.

getTableId

@Nullable
CqlIdentifier getTableId()

If this context belongs to a DAO that was built with a table-parameterized mapper method, the value of that parameter. Otherwise null.

getExecutionProfileName

@Nullable
String getExecutionProfileName()

If this context belongs to a DAO that was built with a method that takes an execution profile name as parameter, the value of that parameter. Otherwise null.

Note that this is mutually exclusive with getExecutionProfile(): at most one of the two methods returns a non-null value (or both return null if no profile was provided).

getExecutionProfile

@Nullable
DriverExecutionProfile getExecutionProfile()

If this context belongs to a DAO that was built with a method that takes an execution profile as parameter, the value of that parameter. Otherwise null.

Note that this is mutually exclusive with getExecutionProfileName(): at most one of the two methods returns a non-null value (or both return null if no profile was provided).

getNameConverter

@NonNull
NameConverter getNameConverter(Class<? extends NameConverter> converterClass)

Returns an instance of the given converter class.

The results of this method are cached at the mapper level. If no instance of this class exists yet for this mapper, a new instance is built by looking for a public no-arg constructor.

getCustomState

@NonNull
Map<Object,Object> getCustomState()

Retrieves any custom state that was set while building the mapper with MapperBuilder.withCustomState(Object, Object).

The returned map is immutable. If no state was set on the builder, it will be empty.

getResultProducer

@NonNull
MapperResultProducer getResultProducer(@NonNull
                                                GenericType<?> resultToProduce)

Returns a component that will execute a statement and convert it into a custom result of the given type.

These components must be registered through the Java Service Provider Interface mechanism, see MapperResultProducerService.

The results of this method are cached at the JVM level.

Throws:

IllegalArgumentException - if no producer was registered for this type.