Index (Java driver for Scylla and Apache Cassandra(R) - object mapper runtime 4.17.0.0 API)

B C D E G H I M N P Q S T U V W

B

build() - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder

C

canProduce(GenericType<?>) - Method in interface com.datastax.oss.driver.api.mapper.result.MapperResultProducer: Checks if this producer can handle a particular result type.
ClusteringColumn - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the field or getter of an Entity property, to indicate that it's a clustering column.
com.datastax.dse.driver.api.mapper.reactive - package com.datastax.dse.driver.api.mapper.reactive
com.datastax.oss.driver.api.mapper - package com.datastax.oss.driver.api.mapper
com.datastax.oss.driver.api.mapper.annotations - package com.datastax.oss.driver.api.mapper.annotations
com.datastax.oss.driver.api.mapper.entity - package com.datastax.oss.driver.api.mapper.entity
com.datastax.oss.driver.api.mapper.entity.naming - package com.datastax.oss.driver.api.mapper.entity.naming
com.datastax.oss.driver.api.mapper.entity.saving - package com.datastax.oss.driver.api.mapper.entity.saving
com.datastax.oss.driver.api.mapper.result - package com.datastax.oss.driver.api.mapper.result
Computed - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the field or getter of an Entity property, to indicate that when retrieving data that the property should be set to the result of computation on the Cassandra side, typically a function call.
copy() - Method in exception com.datastax.oss.driver.api.mapper.MapperException
CqlName - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an Entity class or one of its properties (field or getter), to specify a custom CQL name.
customState - Variable in class com.datastax.oss.driver.api.mapper.MapperBuilder

D

Dao - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an interface that defines a set of query methods, usually (but not necessarily) related to a given entity class.
DaoFactory - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a DAO-producing method in a Mapper interface.
DaoKeyspace - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the parameter of a DaoFactory method that indicates the keyspace to create a DAO for.
DaoProfile - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the parameter of a DaoFactory method that indicates the execution profile to create a DAO for.
DaoTable - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the parameter of a DaoFactory method that indicates the table to create a DAO for.
defaultExecutionProfile - Variable in class com.datastax.oss.driver.api.mapper.MapperBuilder
defaultExecutionProfileName - Variable in class com.datastax.oss.driver.api.mapper.MapperBuilder
defaultKeyspaceId - Variable in class com.datastax.oss.driver.api.mapper.MapperBuilder
DefaultNullSavingStrategy - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao interface to define a default NullSavingStrategy, that will apply to all methods that don't explicitly declare one.
Delete - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that deletes an instance of an Entity-annotated class.
deleteByPrimaryKey() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Builds a delete query to delete an instance of the entity by primary key (partition key + clustering columns).

E

Entity - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a class that will be mapped to a Cassandra table or UDT.
EntityHelper<EntityT> - Interface in com.datastax.oss.driver.api.mapper.entity: A set of utility methods related to a particular mapped entity.
execute(Statement<?>, MapperContext, EntityHelper<?>) - Method in interface com.datastax.oss.driver.api.mapper.result.MapperResultProducer: Executes the statement generated by the mapper, and converts the result to the expected type.

G

get(GettableByName) - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Deprecated.
Use EntityHelper.get(GettableByName, boolean) instead.
get(GettableByName, boolean) - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Gets values from a data structure to fill an entity instance.
getCustomState() - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: Retrieves any custom state that was set while building the mapper with MapperBuilder.withCustomState(Object, Object).
GetEntity - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that converts a core driver data structure into one or more instances of an Entity class.
getEntityClass() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: The class of the mapped entity.
getExecutionProfile() - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: 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.
getExecutionProfileName() - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: 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.
getKeyspaceId() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: The keyspace used in the queries generated by this helper.
getKeyspaceId() - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: If this context belongs to a DAO that was built with a keyspace-parameterized mapper method, the value of that parameter.
getNameConverter(Class<? extends NameConverter>) - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: Returns an instance of the given converter class.
getProducers() - Method in interface com.datastax.oss.driver.api.mapper.result.MapperResultProducerService: Returns the producers provided by this service.
getResultProducer(GenericType<?>) - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: Returns a component that will execute a statement and convert it into a custom result of the given type.
getSession() - Method in interface com.datastax.oss.driver.api.mapper.MapperContext
getTableId() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: The table used in the queries generated by this helper.
getTableId() - Method in interface com.datastax.oss.driver.api.mapper.MapperContext: If this context belongs to a DAO that was built with a table-parameterized mapper method, the value of that parameter.
GetterStyle - Enum in com.datastax.oss.driver.api.mapper.entity.naming: The style of getter that the mapper will look for when introspecting an entity class.

H

HierarchyScanStrategy - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: A strategy to define which ancestors to scan for annotations for Entity-annotated classes and Dao-annotated interfaces.

I

Increment - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that increments a counter table that is mapped to an Entity-annotated class.
Insert - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that inserts an instance of an Entity-annotated class.
insert() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Builds an insert query for this entity.

M

MappedReactiveResultSet<EntityT> - Interface in com.datastax.dse.driver.api.mapper.reactive: A Publisher of mapped entities returned by DAO methods.
Mapper - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an interface that will serve as the entry point to mapper features.
MapperBuilder<MapperT> - Class in com.datastax.oss.driver.api.mapper: Builds an instance of a Mapper-annotated interface wrapping a CqlSession.
MapperBuilder(CqlSession) - Constructor for class com.datastax.oss.driver.api.mapper.MapperBuilder
MapperContext - Interface in com.datastax.oss.driver.api.mapper: A runtime context that gets passed from the mapper to DAO components to share global resources and configuration.
MapperException - Exception in com.datastax.oss.driver.api.mapper: A runtime issue with the object mapper.
MapperException(String, Throwable) - Constructor for exception com.datastax.oss.driver.api.mapper.MapperException
MapperException(String) - Constructor for exception com.datastax.oss.driver.api.mapper.MapperException
MapperResultProducer - Interface in com.datastax.oss.driver.api.mapper.result: A component that can be plugged into the object mapper, in order to return custom result types from DAO methods.
MapperResultProducerService - Interface in com.datastax.oss.driver.api.mapper.result: Provides the custom mapper result types that will be used in an application.

N

NameConverter - Interface in com.datastax.oss.driver.api.mapper.entity.naming: A custom converter to infer CQL column names from the names used in an Entity-annotated class.
NamingConvention - Enum in com.datastax.oss.driver.api.mapper.entity.naming: A built-in convention to infer CQL column names from the names used in an Entity-annotated class.
NamingStrategy - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an Entity to indicate how CQL names will be inferred from the names in the Java class.
NullSavingStrategy - Enum in com.datastax.oss.driver.api.mapper.entity.saving: Defines how null Entity properties will be handled during data insertion.

P

PartitionKey - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the field or getter of an Entity property, to indicate that it's part of the partition key.
PropertyStrategy - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an Entity to customize certain aspects of the introspection process that determines which methods are considered as properties, and how new instances will be created.

Q

Query - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that executes a user-provided query.
QueryProvider - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that delegates the execution of the query to a user-provided class.

S

SCHEMA_VALIDATION_ENABLED_SETTING - Static variable in class com.datastax.oss.driver.api.mapper.MapperBuilder
SchemaHint - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an entity to indicate which type of schema element it is supposed to map to.
SchemaHint.TargetElement - Enum in com.datastax.oss.driver.api.mapper.annotations
Select - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that selects one or more rows, and maps them to instances of an Entity-annotated class.
selectByPrimaryKey() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Builds a select query to fetch an instance of the entity by primary key (partition key + clustering columns).
selectStart() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Builds the beginning of a select query to fetch one or more instances of the entity.
session - Variable in class com.datastax.oss.driver.api.mapper.MapperBuilder
set(EntityT, SettableT, NullSavingStrategy) - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Deprecated.
Use EntityHelper.set(Object, SettableByName, NullSavingStrategy, boolean) instead.
set(EntityT, SettableT, NullSavingStrategy, boolean) - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Sets the properties of an entity instance into a target data structure.
SetEntity - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that fills a core driver data structure from an instance of an Entity class.
SetterStyle - Enum in com.datastax.oss.driver.api.mapper.entity.naming: The style of setter that the mapper will look for when introspecting a mutable entity class.
StatementAttributes - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: A set of compile time parameters to use for mapped queries (this can be used for methods annotated with Delete, Insert, Query, Select or Update).

T

toCassandraName(String) - Method in interface com.datastax.oss.driver.api.mapper.entity.naming.NameConverter: Convert the given Java name into a CQL name.
Transient - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates the field or getter of an Entity property, to indicate that it will not be mapped to any column (neither during reads nor writes).
TransientProperties - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates an Entity to indicate which properties should be considered 'transient', meaning that they should not be mapped to any column (neither during reads nor writes).

U

Update - Annotation Type in com.datastax.oss.driver.api.mapper.annotations: Annotates a Dao method that updates one or more instances of an Entity-annotated class.
updateByPrimaryKey() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Builds a Update query to update an instance of the entity by primary key (partition key + clustering columns).
updateStart() - Method in interface com.datastax.oss.driver.api.mapper.entity.EntityHelper: Builds the beginning of a Update query to update an entity.

V

valueOf(String) - Static method in enum com.datastax.oss.driver.api.mapper.annotations.SchemaHint.TargetElement: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.datastax.oss.driver.api.mapper.entity.naming.GetterStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.datastax.oss.driver.api.mapper.entity.naming.NamingConvention: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.datastax.oss.driver.api.mapper.entity.naming.SetterStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.datastax.oss.driver.api.mapper.entity.saving.NullSavingStrategy: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.datastax.oss.driver.api.mapper.annotations.SchemaHint.TargetElement: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.datastax.oss.driver.api.mapper.entity.naming.GetterStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.datastax.oss.driver.api.mapper.entity.naming.NamingConvention: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.datastax.oss.driver.api.mapper.entity.naming.SetterStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.datastax.oss.driver.api.mapper.entity.saving.NullSavingStrategy: Returns an array containing the constants of this enum type, in the order they are declared.

W

withCustomState(Object, Object) - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder: Stores custom state that will be propagated to MapperContext.getCustomState().
withDefaultExecutionProfile(DriverExecutionProfile) - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder: Specifies a default execution profile name that will be used for all DAOs built with this mapper (unless they specify their own execution profile).
withDefaultExecutionProfileName(String) - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder: Specifies a default execution profile name that will be used for all DAOs built with this mapper (unless they specify their own execution profile).
withDefaultKeyspace(CqlIdentifier) - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder: Specifies a default keyspace that will be used for all DAOs built with this mapper (unless they specify their own keyspace).
withDefaultKeyspace(String) - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder: Shortcut for withDefaultKeyspace(CqlIdentifier.fromCql(keyspaceName)).
withSchemaValidationEnabled(boolean) - Method in class com.datastax.oss.driver.api.mapper.MapperBuilder: Whether to validate mapped entities against the database schema.
wrapError(Exception) - Method in interface com.datastax.oss.driver.api.mapper.result.MapperResultProducer: Surfaces any error encountered in the DAO method (either in the generated mapper code that builds the statement, or during invocation of MapperResultProducer.execute(com.datastax.oss.driver.api.core.cql.Statement<?>, com.datastax.oss.driver.api.mapper.MapperContext, com.datastax.oss.driver.api.mapper.entity.EntityHelper<?>)).

B C D E G H I M N P Q S T U V W