All Classes and Interfaces
Class
Description
An accessor of a property value.
"Add" Expression.
A descriptor for an additional DB entity attached to the main one.
Superclass of aggregated conditional nodes such as NOT, AND, OR.
Base class for all aggregation functions expressions
It's more like marker interface for now.
"And" expression.
Compiles
CommitLogEntity's based on CommitLog annotation.Object that represents Arc identifier.
A Property that represents an "arc" connecting source node to the target node
in the graph.
Implements dependency sorting algorithms for ObjEntities, DbEntities and
Persistent objects.
A factory of
AshwoodEntitySorter.This is a root node of parsed template.
Asterisk operator for COUNT(*) expression.
Defines a property descriptor that is a part of an Entity.
Represents a change in a "value" property, which is either a scalar property
or a to-one entity relationship.
Represents a simple object property.
A DbAdapter that automatically detects the kind of database it is running on
and instantiates an appropriate DB-specific adapter, delegating all
subsequent method calls to this adapter.
Thrown when the pool fails to validate a fresh connection that is known to be in a good state.
Deprecated, for removal: This API element is subject to removal in a future version.
Property that represents non-numeric PK
A
ProjectNodeVisitor that does nothing, used as a convenience superclass
for partial visitors.Property that represents generic attribute.
An abstract property descriptor that delegates property access to an
Accessor.A convenience superclass for SQLAction implementations.
BatchQuery and its descendants allow to group similar data for the batch
database modifications, including inserts, updates and deletes.
Represents a single row of values in a BatchQuery.
A stateless service that translates a batch query of type
T into an immutable
TranslatedBatch.A property accessor that uses set/get methods following JavaBean naming
conventions.
ValidationFailure implementation that described a failure of a single named property of
a Java Bean object.
"Between" expression.
Bitwise conjunction (AND or '&') expression
Bitwise left shift '<<' operation.
Bitwise negation (NOT i.e. inventor or '~') operation .
Bitwise disjunction (OR or '|') expression.
Bitwise right shift '>>' operation.
Bitwise exclusive disjunction (XOR or '^') operation.
Handles
java.lang.Boolean mapping.Handles
byte[], mapping it as either of JDBC types - BLOB or (VAR)BINARY.Handles
java.lang.Byte type mapping.ExtendedType that handles
Calendar fields.A mapping descriptor of a single callback event.
A generic descriptor of a set of standard lifecycle callbacks.
Defines forced capitalization of the result column names in the DataRow.
"CASE-WHEN" expression root node.
Various utils for processing persistent objects and their properties
An entry point for manually building DataSources.
Common superclass for events passed from the EventManager to Listeners.
This interface represents some path in the Cayenne model.
Value object representing segment of a
CayennePathObject representing Cayenne stack.
A convenience class to assemble custom
CayenneRuntime.A generic unchecked exception that may be thrown by Cayenne framework.
Tag interface whose implementors are DI modules that want to be auto-loaded when Cayenne starts.
An exception thrown when a failure occurs while executing a query statement or reading its results.
Represents a Cayenne-managed local Transaction.
Represents a map of changes for a graph of persistent objects.
This is char and Character type mapped to zero or one char String.
Handles
java.lang.String, mapping it as either of JDBC types -
CLOB or (VAR)CHAR.A GraphChangeHandler that loads child ObjectContext diffs into a parent
ObjectContext.
A runtime descriptor of an persistent class.
A factory of
ClassDescriptor instances.An object that holds class descriptors for mapped entities, compiling new
descriptors on demand using an internal chain of descriptor factories.
A
ResourceLocator that looks up resources is the application
classpath based on the current thread ClassLoader.A bounded concurrent map that evicts the entries least recently read.
Base class for
ListProperty and SetPropertyA helper builder for queries selecting individual properties based on the root object.
An annotation that enables commit log tracking for a Persistent entity class.
Deprecated, for removal: This API element is subject to removal in a future version.
use
CommitLog instead.Describes post-commit behavior for a given Cayenne entity.
A
DataChannelSyncFilter that captures commit changes, delegating their
processing to an underlying collection of listeners.An interface of a listener of post-commit events.
Interface (or "Trait") that provides basic functionality for comparable properties.
Assists in implementing
Comparable.compareTo(Object) methods.Decorates a collection of other collections to provide a single unified view.
A GraphDiff that is a list of other GraphDiffs.
A
DeleteDbRowOpFactory enabling "soft delete".Superclass of conditional expressions.
A singleton representing a confidential property value.
A runtime exception thrown on failures in Cayenne configuration.
A service that maps the names of configuration objects to the resource names.
A
ResultIterator wrapper that handles closing a connection.Deprecated, for removal: This API element is subject to removal in a future version.
use the DI keys defined in
CoreModule and the property names defined in
RuntimePropertiesA collection of static conversion utility methods.
A helper class to do property type conversions.
A factory of property type converters.
A DI module containing all Cayenne runtime configuration.
A builder of extensions for
CoreModule.Describes a single immutable CallableStatement parameter binding, pairing a bound value with the
ProcedureParameter that describes it.Class for custom aggregation functions expressions.
DataChannel is an abstraction used by ObjectContexts to obtain mapping metadata and
access a persistent store.
An interface of a filter that allows to intercept DataChannel query operations.
Interface for chain of query filters
An interface of a filter that allows to intercept DataChannel sync operations.
Interface for chain of sync filters
The default implementation of
ObjectContext.A builder of
DataContext instances.A
DataChannel that connects a nested ObjectContext to its parent DataContext.Defines API for a DataContext "delegate" - an object that is temporarily passed control
by DataContext at some critical points in the normal flow of execution.
The default
ObjectStore implementation.DataDomain performs query routing functions in Cayenne.
A stateful commit handler used by DataContext to perform commit operation.
Factory that produces
DataDomainFlushActionA
DataChannel provider that provides a single instance of DataDomain
configured per configuration supplied via injected
ProjectLoader.Stores a collection of related mapping objects that describe database and
object layers of an application.
A loader of DataMaps.
An abstraction of a single physical data storage.
Contains
DataNode configuration.A factory for creating DataNodes from descriptors.
Deprecated, for removal: This API element is subject to removal in a future version.
use
Persistent interface directlyDataRow is a precursor of a persistent object that holds its database values, but models no relationships.
The layout of a
DataRow: the column names in column order, with a lookup of a name to its position.Reads the columns of a layout from rows of any layouts.
A fixed size cache of DataRows keyed by ObjectId.
A factory for creating
DataRowStoreDeprecated, for removal: This API element is subject to removal in a future version.
in favor of
CayenneDataSourceHelper holding DataSource information for the Cayenne-managed DataSource.
Property that represents date/time attribute.
DbAdapter implementation for the DB2 RDBMS.
A sequence-based PK generator used by
DB2Adapter.A Cayenne extension point that abstracts the differences between specifics of
JDBC interfaces to various databases.
A
ProcedureTranslator that resolves the actual translator from DbAdapter.getProcedureTranslator(ProcedureQuery, EntityResolver)
allowing adapters to customize translation.A
SelectTranslator that resolves the actual translator from the DbAdapter.getSelectTranslator(Select, EntityResolver)
allowing adapters to customize translation.A factory interface providing DbAdapter based on JDBC metadata.
A DbAttribute defines a descriptor for a single database table column.
A DbEntity is a mapping descriptor that defines a structure of a database
table.
Utility class that generates database schema based on Cayenne mapping.
Defines a join between two attributes of a given relationship.
DbKeyGenerator is an abstraction of a primary key generator It configures the primary
key generation per DbEntity in a RDBMS independent manner.
Path expression traversing DB relationships and attributes.
A DbRelationship is a descriptor of a database inter-table relationship based
on one or more primary key/foreign key pairs.
Object that represents some change on DB level.
BiFunction that merges two
DbRowOp changing same object.Sorter of
DbRowOp operations.A cached handle to the no-arg constructor of a class.
Default implementation of
DataDomainFlushAction.Factory that produces
DefaultDataDomainFlushAction.A default implementation of
DataRowStoreFactoryA default implementation of
EventManager.A
ProcedureTranslator returned by the base JdbcAdapter.A default implementation of
ProjectMerger.
Default implementation of
ProjectMetaData that stores data in Map.An
QuotingStrategy that wraps identifiers in a pair of (possibly distinct) start/end quote characters.Creates row readers for one executed statement.
An implementation of
RuntimeProperties that returns properties that
were injected via a map in constructor.A
SelectTranslator that translates a FluentSelect by running the TranslationStage
pipeline over a SelectTranslatorContext.Default implementation of
ValueObjectTypeRegistryA value that is not known until a preceding row of the same transaction has been executed, e.g. a generated PK
propagated to a dependent PK or to a foreign key.
Batched delete query.
A factory of delete row ops used by the commit pipeline.
An exception thrown during an attempt to delete an object that has a relationship to a
non-null related object, that has a DENY delete rule.
Special case op, that describes delete/insert sequence of different objects
that have same ObjectId (known example: meaningful PK set to same value as used before).
Defines what happens to the target objects of an ObjRelationship when the source object is deleted.
DeleteRuleUpdater is responsible for auto-setting delete rules for object relationships
DbAdapter implementation for the Derby RDBMS
PK generator for Derby that uses sequences.
Creates a DerbyAdapter if Apache Derby database is detected.
A ResultIterator that does in-memory filtering of rows to return only
distinct rows.
"Divide" expression.
An exception thrown on attempts to access a DataDomain after it was explicitly shut
down by the user.
A non-pooling DataSource implementation wrapping a JDBC driver.
Helper value-object class that used to compare operations by "effective" id (i.e. by id snapshot,
that will include replacement id if any).
"ELSE" part of the case-when expression.
A mapping descriptor of an embeddable class.
A persistent attribute of an embeddable object.
Property that represents object attribute mapped on
Embeddable object.A result set segment mapped to an
Embeddable.An attribute of the ObjEntity that maps to an embeddable class.
An accessor for fields storing embedded objects.
A metadata object that provides mapping of a set of result columns to an Embeddable object.
An abstract descriptor for an entity mapping concept.
A tree structure representing inheritance hierarchy of an ObjEntity and its
subentities.
EntityMergeListener interface defines API useful for listening to
EntityMergeSupport processing.
Property that represents to-one relationships.
Represents a virtual shared namespace for zero or more DataMaps.
A metadata object that provides mapping of a set of result columns to an
ObjEntity.
A "compiled" version of a
EntityResult descriptor.Defines API for sorting of Cayenne entities based on their mutual dependencies.
Creates
EntitySorter instances.An enum constant referenced by the names of its class and constant, as parsed from the "enum:" literal of an
expression String.
An ExtendedType that handles an enum class.
ExtendedTypeFactory for handling Enum types.
"Equal To" expression.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
Objects.equals(Object, Object) or
Objects.deepEquals(Object, Object) directly.An object that passes events between a local EventManager and some other event dispatch
mechanism.
Defines a factory to dynamically create EventBridge instances.
A callback invoked by
EventManager when an event is dispatched to a registered listener.Acts as bridge between an Object that wants to inform others about its
current state or a change thereof (Publisher) and a list of objects interested in the
Subject (Listeners).
This class encapsulates the String that is used to identify the subject that
a listener is interested in.
Superclass of Cayenne expressions: a tree node holding its operands.
RuntimeException thrown on errors during expressions creation/parsing.
Helper class to build expressions.
Named parameter for parameterized expressions.
An interface that Enum classes may implement to map enum instances to arbitrary DB
values that do not match the enum names or positions.
An ExtendedType that handles a Java Enum based upon the Cayenne ExtendedEnumeration
interface.
Defines methods to read Java objects from JDBC ResultSets and write as parameters of PreparedStatements.
ExtendedType factory interface.
Stores ExtendedTypes, implementing an algorithm to determine the right type
for a given Java class.
Represents a container-managed transaction.
Available components of date/time.
Boolean false expression element
Notice that there is one TrueExp and one FalseExp instead of a single BooleanExp
with a Boolean value.
Represents a placeholder for an unresolved relationship from a source object.
A runtime exception thrown when during lazy object initialization Cayenne finds that no
matching row exists in the database for a given ObjectId.
A PropertyAccessor that performs direct Field access.
A default POJO embeddable descriptor.
DbAdapter implementation for the FirebirdSQL RDBMS
SUBSTRING function for Firebird
It has following format:
SUBSTRING (string FROM CAST(?
Base class for
ObjectSelect and ColumnSelectAn action builder for FrontBaseActionBuilder.
DbAdapter implementation for FrontBase RDBMS
Collection of factory methods to create function call expressions.
Implementation of
Persistent that uses Map to store object fields.A Cayenne-supported values object that holds GeoJson string.
Db operation sorted that builds dependency graph and uses topological sort to get final order.
Defines callback API that can be used by object graph nodes to notify of their state
changes.
Represents a change in an object graph.
A utility class that removes redundant and mutually exclusive graph changes from the
graph diff.
An event indicating a change in the object graph.
"Greater Than" expression.
"Greater Than Or Equal To" expression.
DbAdapter implementation for H2 RDBMS.
H2 specific char type handling - used to handle the correct setting of clobs
Default PK generator for H2 that uses sequences for PK generation.
Factory that creates handlers for unparsed elements.
Default implementation of
DeleteDbRowOpFactory producing plain DeleteDbRowOp that translate to SQL
DELETE.Deprecated, for removal: This API element is subject to removal in a future version.
use
Objects.hash(Object...) or a manual 31 * h + Objects.hashCode(x) loopDbAdapter implementation for the HSQLDB RDBMS.
Works around HSQLDB's pickiness about stored procedure syntax.
Detects HSQLDB database from JDBC metadata.
This data object like
GenericPersistentObject uses Map to store generic attributes,
only difference is that this Map will be created lazily at first write, thus reducing memory penalty if possible.A stateless read-only accessor of the map key value that is based on the Persistent
object id.
Base class for properties mapped to PK
helper class to generate pseudo-GUID sequences.
A synchronized list that serves as a container of Persistent objects.
A base superclass for queries that resolve into some other queries during the
routing phase.
"In" expression.
DbAdapter implementation for Ingres RDBMS.
Ingres-specific sequence based PK generator.
Detects Ingres database from JDBC metadata.
Batched INSERT query.
Extended type factory that produces types for Cayenne internal value types that could potentially make it to the DB.
Marker interface, that should be used by any internal value types, that could potentially get to the SQL
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (with java-like unicode escape processing).
An implementation of interface CharStream, where the stream is assumed to
contain only ASCII characters (with java-like unicode escape processing).
A base for ExtendedTypes of the
java.time classes that JDBC 4.2 drivers read and write natively via
ResultSet.getObject(int, Class) and PreparedStatement.setObject(int, Object, int).A factory of default SQLActions.
A generic DbAdapter implementation.
Default primary key generator implementation.
The stack that
QLParser builds expression trees on.Enumerates supported JOIN types.
A Cayenne-supported values object that holds Json string.
Simple utils to process JSON.
A ClassDescriptor wrapper that compiles decorated descriptor lazily on first access.
"Less Then" expression.
"Less than or equal to" expression.
A registry of lifecycle callbacks for all callback event types.
Defines possible entity object lifecycle events.
A callback interface to listen to persistent object lifecycle events.
"Like" expression.
"Case insensitive like" expression.
expressions: LIKE, ILIKE, NOT LIKE, NOT ILIKE + ESCAPE
A leaf expression representing an immutable collection of values.
Property that represents to-many relationship mapped on
List.Deprecated, for removal: This API element is subject to removal in a future version.
no longer registered by default.
Deprecated, for removal: This API element is subject to removal in a future version.
no longer registered by default.
Provides access to various modeler resources (mainly strings) obtained via a
ResourceBundle.
Deprecated, for removal: This API element is subject to removal in a future version.
no longer registered by default.
A wrapper for
UnmanagedPoolingDataSource that automatically manages
the underlying connection pool size.A query that represents a named parameterized non selecting query stored in the mapping.
A query that represents a named parameterized selecting query stored in the mapping.
Defines API of a container of DbEntities, ObjEntities, Procedures, Queries
and other mapping objects.
Property that represents to-many relationship mapped on
Map.A default implementation of the
QueryCache interface that stores data in non-expiring bounded maps, one
per cache group, evicting the entries least recently used.A Blob implementation that stores content in memory.
A Clob implementation that stores contents in memory.
"Multiply" expression.
A mutable implementation of
ChangeMap.A mutable implementation of
ObjectChange.DbAdapter implementation for MySQL RDBMS.
A translator that adds parenthesis to no-param queries.
Detects MySQL database from JDBC metadata.
Base class for handlers that can delegate execution of unknown tags to
handlers produced by factory.
Describes a single database-native (external) SQL type that a JDBC type (see
Types) maps to."Negate" expression.
Unary minus.
A
QueryCache wrapper that introduces a key namespace on top of a
delegate shared cache.All AST nodes must implement this interface.
An abstract superclass of operations on individual nodes and arcs in a
digraph.
A GraphDiff representing a change in node ID.
Noop implementation of
ProjectMetaData.A no-op
SQLLogger."Not Between" expression.
"Not equal to" expression.
"Not" expression.
"Not In" expression.
"Not Like" expression.
"Not like, ignore case" expression.
Property that represents numeric PK
Property that represents attributes mapped on numeric types
An ObjAttribute is a mapping descriptor of a Java class property.
Accumulates changes of a single object with a transaction.
Defines types of tracked object changes.
The main user-facing persistence API to work with a database.
A factory for regular and nested contexts.
A dynamic GraphDiff that represents a delta between object simple properties
at diff creation time and its current state.
A portable global identifier for persistent objects.
A selecting query providing chainable API.
Builds
DataRow snapshots of persistent objects from their current, possibly uncommitted, in-memory state.A registry of persistent objects managed by an
ObjectContext, keyed by ObjectId.A GraphDiff facade for the ObjectStore changes.
This is a default ExtendedType that relies on JDBC driver to determine the result type.
ObjEntity is a mapping descriptor for a Persistent Java class.
Describes an association between two Java classes mapped as source and target
ObjEntity.
Defines API that allows a DataNode to obtain information about query execution strategy.
Defines a set of callback methods that allow
DataNode to pass back query
results and notify caller about exceptions.Factory that wraps provided ID to be suitable for the better processing in the flush operation.
An exception thrown on optimistic lock failure.
DbAdapter implementation for Oracle RDBMS
Oracle specific CHAR type handling.
Sequence-based primary key generator implementation for Oracle.
Defines object sorting criteria, used either for in-memory sorting of object
lists or as a specification for building ORDER BY clause of a
SelectQuery query.
Orderings is provided so that you can chain Ordering together and then use
the result to pass into methods that require List<Ordering>
"Or" expression.
A
QueryResult item holding the values of the OUT and INOUT parameters of a stored procedure call, keyed by
parameter name.This exception is thrown when parse errors are encountered.
This exception is thrown when parse errors are encountered.
Generic path expression.
Property that represents path segment (relationship or embeddable).
Superclass of pattern matching nodes.
Deprecated, for removal: This API element is subject to removal in a future version.
unused, it is trivial to create per-adapter classes without the common superclass
Defines a set of object states from the point of view of persistence.
Defines minimal API of an object that can be persisted via Cayenne.
A default ClassDescriptor implementation for persistent objects.
A convenience superclass for
ClassDescriptorFactory implementors.Base implementation of
Persistent, have no assumption about how data is actually stored.A
ClassDescriptorFactory that creates descriptors for classes implementing Persistent.Defines methods to support automatic primary key generation.
Simple mapper of Object[] to a POJO class.
A Connection wrapper that interacts with the UnmanagedPoolingDataSource, allowing to recycle connections and track
failures.
Deprecated, for removal: This API element is subject to removal in a future version.
in favor of
CayenneDataSourceA collection of pooling parameters used by
UnmanagedPoolingDataSource.An annotation to place on the entity event listener method to receive
LifecycleEvent.POST_ADD events.DbAdapter implementation for PostgreSQL RDBMS
Default PK generator for PostgreSQL that uses sequences for PK generation.
A translator that adds parenthesis to no-param queries.
An annotation to place on the entity event listener method to receive
LifecycleEvent.POST_LOAD events.An annotation to place on the entity event listener method to receive
LifecycleEvent.POST_PERSIST events.An annotation to place on the entity event listener method to receive
LifecycleEvent.POST_REMOVE events.An annotation to place on the entity event listener method to receive
LifecycleEvent.POST_UPDATE events.A hierarchical visitor interface for traversing a tree of PrefetchTreeNodes.
A SelectQuery to perform a prefetch based on another query.
Defines a node in a prefetch tree.
An annotation to place on the entity event listener method to receive
LifecycleEvent.PRE_PERSIST events.An annotation to place on the entity event listener method to receive
LifecycleEvent.PRE_REMOVE events.An annotation to place on the entity event listener method to receive
LifecycleEvent.PRE_UPDATE events.A mapping descriptor for a database stored procedure.
A SQLAction that runs a stored procedure.
Fluent API for calling stored procedures.
An adapter-independent description of a single column in a
ProcedureQuery result set.A descriptor for the Procedure parameter.
A query based on Procedure.
A handler of the "procedureQuery" tag of a DataMap.
A service that translates a
ProcedureQuery into a TranslatedProcedure.A Cayenne mapping project, normally loaded from XML configuration.
Upgrades project or DataMap XML resources created by older versions of Cayenne to the current project version.
A loader of projects.
Merges multiple descriptors into a single runtime descriptor.
Storage for all kind of meta data that is not required for runtime.
Implemented by the "nodes" on the Cayenne project tree.
A visitor interface for implementing operations on different types of
ProjectNode objects.Base interface for all types of properties
A utility accessor class that wraps a simple property.
A base interface for various types of property changes.
Defines bean property API used by Cayenne to access object data, do faulting
and graph maintenance tasks.
An unchecked exception thrown on errors during property access, either within a
Accessor or a Property.
Factory class that produces all property types.
Utility methods to quickly access object properties.
Deprecated, for removal: This API element is subject to removal in a future version.
iterate over
ClassDescriptor.getProperties(), ClassDescriptor.getDeclaredProperties()
or ClassDescriptor.getAllProperties() and switch on the property type (AttributeProperty,
ToOneProperty, ToManyProperty) instead.An immutable batch parameter corresponding to a single PreparedStatement placeholder, carrying the values of all
batch rows for that placeholder alongside the static position and column metadata.
Describes a single immutable PreparedStatement parameter binding.
Parser of Cayenne expressions and queries.
A function run over a fresh parser, see
QLParser.query() or QLParser.expression().Token literal values and constants.
Token Manager.
Prints a select query as a String that
QLParser can parse back, the opposite of QLSelectBuilder.Qualifier of DB row.
Defines minimal API of a query descriptor that is executable via Cayenne.
Defines API of a cache that stores query results.
A factory that is used by the cache to rebuild expired entries.
Defines query result caching policy.
Generic descriptor of a Cayenne query.
A base of the handlers of the query tags of a DataMap.
Provides a common interface for accessing query metadata.
A single item of a multipart query result.
An interface used by Queries to route themselves to an appropriate DataNode.
Encapsulates a database-specific SQL identifier quoting style (the start and end quote characters).
A minimal
Transaction for read-only (selecting) queries that run outside a managed
transaction.Defines a relationship between two entities.
Interface (or "Trait") that provides basic functionality for all types of relationships.
An abstraction of a resource whose data can be accessed via a URL.
Defines API of a batch iterator over the ResultIterator returned as a result of
Select queries execution.
Defines API of an iterator over the records returned as a result of selecting queries execution.
A callback interface invoked on each row when iterating over
ResultIterator.A single segment of a query result set mapping.
A query result set mapping.
A strategy class that encapsulates an algorithm for converting a single ResultSet row into a DataRow.
Creates RowReader instances for executed queries.
A descriptor of a ResultSet column.
A ResultIterator over a JDBC ResultSet.
Represents a properties map for a given
CayenneRuntime.A superclass of nested tag handlers for parsing of XML documents with SAX.
A plain value in the place of an expression, e.g. a constant select column or a whole where clause.
A result set segment mapped to a single scalar value.
A strategy for auto generating a database schema on the application startup.
A common interface for grouping together different kinds of queries that
return results.
A SQLAction that handles SelectQuery execution.
Deprecated, for removal: This API element is subject to removal in a future version.
this query is a thin wrapper around an
ObjectSelect.A mapped select query, defined by a String in the syntax of
ObjectSelect.parse(String, Object...).The kind of the objects that a select query fetches, see
SelectQueryDescriptor.getResultKind().A handler of the "objectQuery" tag of a DataMap.
A
QueryResult item holding a list of objects or data rows produced by a selecting query.A service that translates a
Select query into a TranslatedSelect.Property that represents root entity
A common superclass for sequence-based primary key generators.
Deprecated, for removal: This API element is subject to removal in a future version.
use
CayenneRuntime class insteadProperty that represents to-many relationship mapped on
Set.Handles
java.lang.Short type mapping.A descriptor of an "attribute" persistent property.
Represents a generic validation failure that contains
failed object and a message describing the failure.
Optimized mutable single-entry map.
A SchemaUpdateStrategy that does nothing.
A
SQLLogger that emits compact, single-line messages through slf4j-api under the fixed logger name
cayenne-sql.Event sent on modification of the DataRowStore.
Incrementing global snapshot version generator.
A "soft" delete op that is executed as an UPDATE setting the soft-delete flag column to
true instead of a
SQL DELETE, leaving the row physically in the table.Constants to order query results (the ORDER BY clause).
An annotation that defines the insertion sorting "weight" of an entity that is used
when sorting DB operations.
Defines API for query execution strategy over JDBC connection (as in Strategy Pattern).
A factory interface to create standard SQLActions for a set of standard queries.
A generic query based on raw SQL and featuring fluent API.
A SQLite database adapter.
Detects SQLite database from JDBC metadata.
A logging service used by Cayenne to output database interactions as compact, single-line messages.
A metadata object that defines how a row in a result set can be converted to
result objects.
Resolves the
SQLResult collected by the column extractors into
ResultSegments with column offsets matching the translated SELECT column list.A selecting query based on raw SQL and featuring fluent API.
Cayenne DbAdapter implementation for Microsoft SQL Server RDBMS.
Primary key generator implementation for Sybase.
ProcedureAction for SQLServer MS JDBC driver.
Detects SQLServer database from JDBC metadata.
SQL tree processor that supports OFFSET X ROWS FETCH NEXT Y ROWS ONLY clause
for the SQLServer 2012 and later.
A query that executes unchanged (except for template preprocessing) "raw" SQL
specified by the user.
Implements a strategy for execution of SQLTemplates.
A handler of the "sqlQuery" tag of a DataMap.
Parser of Cayenne Templates.
Token literal values and constants.
Token Manager.
Implements utility methods used inside Velocity templates when rendering
SQLTemplates.
Property that represents attributes mapped on string types
"Subtract" expression.
DbAdapter implementation for Sybase RDBMS.
Primary key generator implementation for Sybase.
Detects Sybase database from JDBC metadata.
"THEN" part of the case-when expression.
Can convert to any class that has a constructor that takes a
single Object or a single String parameter.
Describes the input token stream.
Describes the input token stream.
Token Manager Error.
Token Manager Error.
An abstract superclass of lazily faulted to-many relationship collections.
A list that holds objects for to-many relationships, lazily resolved on first access.
A property representing a map of objects keyed by one of the object properties.
A property representing a collection of objects.
Represents a change in a to-many relationship property to another entity.
A set that holds objects for to-many relationships, lazily resolved on first access.
An ArcProperty that points to a single graph node.
A utility class to simplify implementation of Object toString methods.
Cayenne Transaction interface.
Descriptor that allows to customize transaction logic.
Builder class for the TransactionDescriptor.
A
DataChannelSyncFilter that provides transactions.A callback that is notified as transaction progresses through stages.
An optional utility service that simplifies wrapping multiple operations in
transactions.
Propagation behavior of transaction
An immutable result of translating a batch query: the SQL String shared by all rows of the batch, and one
PSBatchParameter per PreparedStatement placeholder, each carrying the values of all batch rows for
its placeholder.An immutable result of translating a
ProcedureQuery to a stored procedure call.An immutable result of translating a
Select query to SQL,
produced by SelectTranslator.translate(Select, DbAdapter, EntityResolver).A translated form of a Query used to generated PreparedStatements.
A common supertype for the immutable results of translating a query to SQL.
Expression visitor interface.
Deprecated, for removal: This API element is subject to removal in a future version.
as
TraversalHandler has default no-op implementations for all methodsBoolean true expression element Notice that there is one TrueExp and one
FalseExp instead of a single BooleanExp with a Boolean value.
A utility class that handles mappings of JDBC data types to the database
types and Java types.
A non-blocking
DataSource with a pool of connections.An exception indicating that a connection request waiting in the queue
timed out and was unable to obtain a connection.
A runtime exception thrown when
PropertyUtils.getProperty() finds that
there is a null value in middle of the resolved path.Thrown by the XML handlers when the project version of a document is not the current one.
Batched UPDATE query.
A
QueryResult item holding the update counts produced by a non-selecting query.A context for an XML document of a project or a DataMap being upgraded.
A step of the project upgrade that brings the XML and the model from the previous project version to the version
it reports in
UpgradeHandler.getVersion().Upgrade handler for the project version "10" introduced by 4.1.M1 release.
Upgrade handler for the project version "11" introduced by 5.0.M1 release.
Upgrade handler for the project version "12" introduced by 5.0.M2 release.
Upgrade handler for the project version "13" Changes: DataNode removal from Cayenne projects.
Upgrades projects to version 14
An enum indicating what type of upgrade, if any, is needed and possible to bring the
project configuration format in sync with the current Cayenne runtime.
A
Resource implementation wrapping a resource URL.Contains various unorganized static utility methods used across Cayenne.
Maps
java.util.Date to any of the three database date/time types: TIME,
DATE, TIMESTAMP.An ExtendedType for
java.util.UUID that picks the storage format from the JDBC type of the mapped
column:
character columns store the canonical 36-char string;
binary columns store the 16-byte big-endian form, most significant bits first;
anything else is passed to the driver as an object, which is how a PostgreSQL native
uuid column works.
Deprecated, for removal: This API element is subject to removal in a future version.
no longer registered by default.
Defines a number of callback methods that allow an object to be validated before safe.
An exception thrown on unsuccessful validation.
Defines a single failure during the validation process.
Represents a result of a validation execution.
Descriptor and serialization helper for custom value objects that can be safely stored in the DB.
Registry of user-defined descriptors of custom value objects' classes.
Collection of values that should be inserted or updated in DB.
Handler that can validate root tag name, version and namespace.
A noop type that is sometimes useful to suppress extended types operations.
EntitySorter that takes into account entity "weights", and otherwise delegating to
another (topological) sorter.
"WHEN" part of the case-when expression.
A Cayenne-supported value object holding a WKT geometry String.
A helper class to encode objects to XML.
Interface for Cayenne objects that can be saved to XML.
PersistentObjectdirectly