# All Classes and Interfaces

Class
Description
AbstractMappedQuery
AbstractQuery
A common superclass of Cayenne queries.
Accessor
An accessor of a property value.
AccessorFactory
AdditionalDbEntityDescriptor
A descriptor for an additional DB entity attached to the main one.
AdhocObjectFactory
Creates objects for user-provided String class names, injecting dependencies into them.
AggregateConditionNode
Superclass of aggregated conditional nodes such as NOT, AND, OR.
AggregateConditionNode
Superclass of aggregated conditional nodes such as NOT, AND, OR.
AliasedNode
AnnotationCommitLogEntityFactory
Compiles `CommitLogEntity`'s based on `CommitLog` annotation.
ArcCreateOperation
ArcDeleteOperation
ArcId
Object that represents Arc identifier.
ArcIterator<E,V>
ArcProperty
A Property that represents an "arc" connecting source node to the target node in the graph.
ArrayUtil
AshwoodEntitySorter
Implements dependency sorting algorithms for ObjEntities, DbEntities and Persistent objects.
AshwoodEntitySorterFactory
A factory of `AshwoodEntitySorter`.
ASTAbs
ASTAdd
"Add" Expression.
ASTAggregateFunctionCall
Base class for all aggregation functions expressions It's more like marker interface for now.
ASTAll
ASTAnd
"And" expression.
ASTAny
ASTArray
ASTAsterisk
Asterisk operator for COUNT(*) expression.
ASTAvg
ASTBetween
"Between" expression.
ASTBitwiseAnd
Bitwise conjunction (AND or '&') expression
ASTBitwiseLeftShift
Bitwise left shift '<<' operation.
ASTBitwiseNot
Bitwise negation (NOT i.e. inventor or '~') operation .
ASTBitwiseOr
Bitwise disjunction (OR or '|') expression.
ASTBitwiseRightShift
Bitwise right shift '>>' operation.
ASTBitwiseXor
Bitwise exclusive disjunction (XOR or '^') operation.
ASTBlock
This is a root node of parsed template.
ASTBoolScalar
ASTCaseWhen
"CASE-WHEN" expression root node.
ASTConcat
ASTCount
ASTCurrentDate
ASTCurrentTime
ASTCurrentTimestamp
ASTCustomAggregate
Class for custom aggregation functions expressions.
ASTCustomFunction
ASTCustomOperator
ASTDbIdPath
ASTDbPath
Path expression traversing DB relationships and attributes.
ASTDirective
ASTDistinct
ASTDivide
"Divide" expression.
ASTElse
"ELSE" part of the case-when expression.
ASTEnclosingObject
ASTEnum
Scalar node that represents constant enumeration value.
ASTEqual
"Equal To" expression.
ASTExists
ASTExpression
ASTExtract
ASTExtract.DateTimePart
Available components of date/time.
ASTFalse
Boolean false expression element Notice that there is one ASTTrue and one ASTFalse instead of a ASTBoolean with a Boolean value.
ASTFloatScalar
ASTFullObject
ASTFunctionCall
ASTGreater
"Greater Than" expression.
ASTGreaterOrEqual
"Greater Than Or Equal To" expression.
ASTIfElse
ASTIn
"In" expression.
ASTIntScalar
ASTLength
ASTLess
"Less Then" expression.
ASTLessOrEqual
"Less than or equal to" expression.
ASTLike
"Like" expression.
ASTLikeIgnoreCase
"Case insensitive like" expression.
ASTList
A leaf expression representing an immutable collection of values.
ASTLocate
ASTLower
ASTMax
ASTMethod
ASTMin
ASTMod
ASTMultiply
"Multiply" expression.
ASTNamedParameter
A named expression parameter.
ASTNegate
"Negate" expression.
ASTNot
"Not" expression.
ASTNotBetween
"Not Between" expression.
ASTNotEqual
"Not equal to" expression.
ASTNotExists
ASTNotIn
"Not In" expression.
ASTNotLike
"Not Like" expression.
ASTNotLikeIgnoreCase
"Not like, ignore case" expression.
ASTObjPath
ASTOr
"Or" expression.
ASTPath
Generic path expression.
ASTScalar
A scalar value wrapper expression.
ASTSqrt
ASTStringScalar
ASTSubquery
ASTSubstring
ASTSubtract
"Subtract" expression.
ASTSum
ASTText
ASTThen
"THEN" part of the case-when expression.
ASTTrim
ASTTrue
Boolean true expression element Notice that there is one ASTTrue and one ASTFalse instead of a ASTBoolean with a Boolean value.
ASTUpper
ASTVariable
ASTWhen
"WHEN" part of the case-when expression.
Attribute<E,A,R>
Defines a property descriptor that is a part of an Entity.
AttributeChange
Represents a change in a "value" property, which is either a scalar property or a to-one entity relationship.
AttributeFault
AttributeProperty
Represents a simple object property.
AutoAdapter
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.
BadValidationQueryException
Thrown when the pool fails to validate a fresh connection that is known to be in a good state.
BaseArcProperty
A base implementation of the `ArcProperty`.
BaseBatchTranslator<T>
BaseBuilder
BaseConfigurationNodeVisitor<T>
A `ConfigurationNodeVisitor` that does nothing, used as a convenience superclass for partial visitors.
BaseContext
Deprecated, for removal: This API element is subject to removal in a future version.
use `DataContext` directly
BaseDataObject
Deprecated, for removal: This API element is subject to removal in a future version.
use `PersistentObject` directly
BaseDbRowOp
BaseIdProperty<E>
Property that represents non-numeric PK
BaseProperty<E>
Property that represents generic attribute.
BaseProperty
An abstract property descriptor that delegates property access to an `Accessor`.
BaseSchemaUpdateStrategy
BaseSQLAction
A convenience superclass for SQLAction implementations.
BaseSQLTreeProcessor
BaseToManyProperty
A generic superclass of CollectionProperty implementations.
BaseToOneProperty
A convenience base superclass for `ToOneProperty` implementors.
BaseTransaction
BatchAction
BatchQuery
BatchQuery and its descendants allow to group similar data for the batch database modifications, including inserts, updates and deletes.
BatchQueryRow
Represents a single row of values in a BatchQuery.
BatchTranslator<T>
A stateless service that translates a batch query of type `T` into an immutable `TranslatedBatch`.
BeanAccessor
A property accessor that uses set/get methods following JavaBean naming conventions.
BeanValidationFailure
ValidationFailure implementation that described a failure of a single named property of a Java Bean object.
BeforeScopeEnd
An annotation used by objects that want to receive scope ending events from the DI registry.
BetweenNode
BigDecimalType
BigDecimalValueType
BigIntegerValueType
Bind
BindEqual
Binder
An object passed to a `Module` by the DI container during initialization, that provides the API for the module to bind its services to the container.
BindingBuilder<T>
A binding builder that helps with fluent binding creation.
BindNotEqual
BindObjectEqual
BindObjectNotEqual
BitwiseNotNode
BooleanType
Handles `java.lang.Boolean` mapping.
ByteArrayType
Handles `byte[]`, mapping it as either of JDBC types - BLOB or (VAR)BINARY.
ByteType
Handles `java.lang.Byte` type mapping.
CacheableQuery
Shared functionality for cacheable queries.
CalendarType<T>
ExtendedType that handles `Calendar` fields.
CallbackDescriptor
A mapping descriptor of a single callback event.
CallbackMap
A generic descriptor of a set of standard lifecycle callbacks.
CapsStrategy
Defines forced capitalization of the result column names in the DataRow.
CaseNode
Cayenne
Various utils for processing persistent objects and their properties
CayenneDataSource
An entry point for manually building DataSources.
CayenneDataSource.Builder
CayenneEvent
Common superclass for events passed from the EventManager to Listeners; encapsulates optional event information.
CayenneMapEntry
Defining a double-linked named entry in CayenneMap.
CayennePath
This interface represents some path in the Cayenne model.
CayennePathSegment
Value object representing segment of a `CayennePath`
CayenneRuntime
Object representing Cayenne stack.
CayenneRuntimeBuilder
A convenience class to assemble custom `CayenneRuntime`.
CayenneRuntimeException
A generic unchecked exception that may be thrown by Cayenne framework.
CayenneRuntimeModuleProvider
This interface implementations will be used by `CayenneRuntimeBuilder` to auto-load runtime modules.
CayenneSqlException
An exception thrown when a failure occurs while executing a query statement or reading its results.
CayenneTransaction
Represents a Cayenne-managed local Transaction.
ChangeMap
Represents a map of changes for a graph of persistent objects.
CharacterValueType
This is char and Character type mapped to zero or one char String.
CharType
Handles `java.lang.String`, mapping it as either of JDBC types - CLOB or (VAR)CHAR.
ChildDiffLoader
A GraphChangeHandler that loads child ObjectContext diffs into a parent ObjectContext.
ChildProcessor<T>
ClassDescriptor
A runtime descriptor of an persistent class.
ClassDescriptorFactory
A factory of `ClassDescriptor` instances.
ClassDescriptorMap
An object that holds class descriptors for mapped entities, compiling new descriptors on demand using an internal chain of descriptor factories.
ClassLoaderManager
Maps ClassLoaders to resources.
ClassLoaderResourceLocator
A `ResourceLocator` that looks up resources is the application classpath based on the current thread ClassLoader.
CollectionProperty<V,E>
Base class for `ListProperty` and `SetProperty`
ColumnNode
ColumnNodeBuilder
ColumnSelect<T>
A helper builder for queries selecting individual properties based on the root object.
CommitLog
An annotation that enables commit log tracking for a Persistent entity class.
CommitLog
Deprecated, for removal: This API element is subject to removal in a future version.
use `CommitLog` instead.
CommitLogEntity
Describes post-commit behavior for a given Cayenne entity.
CommitLogEntityFactory
CommitLogFilter
A `DataChannelSyncFilter` that captures commit changes, delegating their processing to an underlying collection of listeners.
CommitLogListener
An interface of a listener of post-commit events.
ComparableProperty<E>
Interface (or "Trait") that provides basic functionality for comparable properties.
CompareToBuilder
Assists in implementing `Comparable.compareTo(Object)` methods.
CompositeCollection<E>
Decorates a collection of other collections to provide a single unified view.
CompoundDiff
A GraphDiff that is a list of other GraphDiffs.
ConcurrentLinkedHashMap<K,V>
A hash table supporting full concurrency of retrievals, adjustable expected concurrency for updates, and a maximum capacity to bound the map by.
ConcurrentLinkedHashMap.Builder<K,V>
A builder that creates `ConcurrentLinkedHashMap` instances.
ConditionalSoftDeleteDbRowOpFactory
A `DeleteDbRowOpFactory` enabling "soft delete".
ConditionNode
Superclass of conditional expressions.
Confidential
A singleton representing a confidential property value.
ConfigurationException
A runtime exception thrown on failures in Cayenne configuration.
ConfigurationNameMapper
A service that maps the names of configuration objects to the resource names.
ConfigurationNode
Implemented by the "nodes" on the Cayenne configuration tree.
ConfigurationNodeVisitor<T>
A visitor interface for implementing operations on different types of `ConfigurationNode` objects.
ConfigurationTree<T>
A tree of configuration nodes that contains extra information about the nodes, such as load errors.
ConnectionAwareResultIterator<T>
A `ResultIterator` wrapper that handles closing a connection.
Constants
Defines the names of runtime properties and named collections used in DI modules.
ConstructorInjectingDecoratorProvider<T>
Context
ConversionUtil
A collection of static conversion utility methods.
Converter<T>
A helper class to do property type conversions.
ConverterFactory
A factory of property type converters.
ConvertNode
CoreModule
A DI module containing all Cayenne runtime configuration.
CoreModuleExtender
A builder of extensions for `CoreModule`.
CoreModuleProvider
CoreModule auto-loading facility.
CreateIfNoSchemaStrategy
CSParameter<T>
Describes a single immutable CallableStatement parameter binding, pairing a bound value with the `ProcedureParameter` that describes it.
DataChannel
DataChannel is an abstraction used by ObjectContexts to obtain mapping metadata and access a persistent store.
DataChannelDescriptor
A descriptor of a DataChannel normally loaded from XML configuration.
DataChannelDescriptorLoader
An object that can load a named `DataChannelDescriptor` from some configuration source.
DataChannelDescriptorMerger
Merges multiple descriptors into a single runtime descriptor.
DataChannelHandler
DataChannelListener
A listener of `DataChannel` lifecycle events.
DataChannelLoaderListener
DataChannelMetaData
Storage for all kind of meta data that is not required for runtime.
DataChannelQueryFilter
An interface of a filter that allows to intercept DataChannel query operations.
DataChannelQueryFilterChain
Interface for chain of query filters
DataChannelSyncCallbackAction
DataChannelSyncFilter
An interface of a filter that allows to intercept DataChannel sync operations.
DataChannelSyncFilterChain
Interface for chain of sync filters
DataContext
The most common implementation of `ObjectContext`.
DataContextDelegate
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.
DataContextFactory
DataDomain
DataDomain performs query routing functions in Cayenne.
DataDomainFlushAction
A stateful commit handler used by DataContext to perform commit operation.
DataDomainFlushActionFactory
Factory that produces `DataDomainFlushAction`
DataDomainLoadException
DataDomainProvider
A `DataChannel` provider that provides a single instance of DataDomain configured per configuration supplied via injected `DataChannelDescriptorLoader`.
DataMap
Stores a collection of related mapping objects that describe database and object layers of an application.
DataMapHandler
DataMapLoader
A loader of DataMaps.
DataMapLoaderListener
DataNode
An abstraction of a single physical data storage.
DataNodeDescriptor
Contains `DataNode` configuration.
DataNodeDescriptor.Builder
DataNodeDescriptors
DataNodeFactory
A factory for creating DataNodes from descriptors.
DataObject
Deprecated, for removal: This API element is subject to removal in a future version.
use `Persistent` interface directly
DataRow
DataRow a map that holds values retrieved from the database for a given query row.
DataRowStore
A fixed size cache of DataRows keyed by ObjectId.
DataRowStoreFactory
A factory for creating `DataRowStore`
DataSourceBuilder
Deprecated, for removal: This API element is subject to removal in a future version.
in favor of `CayenneDataSource`
DataSourceDescriptor
Helper holding DataSource information for the Cayenne-managed DataSource.
DateProperty<E>
Property that represents date/time attribute.
DateType
DB2ActionBuilder
DB2Adapter
DbAdapter implementation for the DB2 RDBMS.
DB2EJBQLConditionTranslator
DB2EJBQLTranslator
DB2PkGenerator
A sequence-based PK generator used by `DB2Adapter`.
DB2SelectAction
DB2Sniffer
DB2SQLTreeProcessor
DbAdapter
A Cayenne extension point that abstracts the differences between specifics of JDBC interfaces to various databases.
DbAdapterDelegatedEJBQLTranslator
An `EJBQLTranslator` that resolves the actual translator from `DbAdapter.getEjbqlTranslator()` allowing adapters to customize translation.
DbAdapterDelegatedProcedureTranslator
A `ProcedureTranslator` that resolves the actual translator from `DbAdapter.getProcedureTranslator(ProcedureQuery, EntityResolver)` allowing adapters to customize translation.
DbAdapterDelegatedSelectTranslator
A `SelectTranslator` that resolves the actual translator from the `DbAdapter.getSelectTranslator(Select, EntityResolver)` allowing adapters to customize translation.
DbAdapterDetector
A factory interface providing DbAdapter based on JDBC metadata.
DbAttribute
A DbAttribute defines a descriptor for a single database table column.
DbEntity
A DbEntity is a mapping descriptor that defines a structure of a database table.
DbEntityHandler
DbGenerator
Utility class that generates database schema based on Cayenne mapping.
DbJoin
Defines a join between two attributes of a given relationship.
DbKeyGenerator
DbKeyGenerator is an abstraction of a primary key generator It configures the primary key generation per DbEntity in a RDBMS independent manner.
DbKeyGeneratorHandler
DbRelationship
A DbRelationship is a descriptor of a database inter-table relationship based on one or more primary key/foreign key pairs.
DbRelationshipHandler
DbRowOp
Object that represents some change on DB level.
DbRowOpMerger
BiFunction that merges two `DbRowOp` changing same object.
DbRowOpSorter
Sorter of `DbRowOp` operations.
DbRowOpType
DbRowOpVisitor<T>
DbRowOpWithQualifier
DbRowOpWithValues
DecoratorBuilder<T>
DeepMergeOperation
Deprecated, for removal: This API element is subject to removal in a future version.
unused
DefaultAdhocObjectFactory
A default implementation of `AdhocObjectFactory` that creates objects using default no-arg constructor and injects dependencies into annotated fields.
DefaultClassLoaderManager
A `ClassLoaderManager` that
DefaultConfigurationNameMapper
DefaultDataChannelDescriptorMerger
A default implementation of `DataChannelDescriptorMerger`.
DefaultDataChannelMetaData
Default implementation of `DataChannelMetaData` that stores data in Map.
DefaultDataDomainFlushAction
Default implementation of `DataDomainFlushAction`.
DefaultDataDomainFlushAction.EmptyRowChecker
DefaultDataDomainFlushAction.PhantomDbRowOpCleaner
DefaultDataDomainFlushActionFactory
Factory that produces `DefaultDataDomainFlushAction`.
DefaultDataNodeFactory
DefaultDataRowStoreFactory
A default implementation of `DataRowStoreFactory`
DefaultDbRowOpSorter
DefaultDbRowOpSorter.DbRowComparator
DefaultDbRowOpSorter.DbRowTypeVisitor
DefaultEmbeddableResultSegment
DefaultEntityResultSegment
DefaultEventManager
A default implementation of `EventManager`.
DefaultHandlerFactory
DefaultInjector
A default Cayenne implementations of a DI injector.
DefaultObjectMapRetainStrategy
Default implementation of `ObjectMapRetainStrategy`.
DefaultObjectStoreFactory
A default implementation of `ObjectStoreFactory` which makes decision to turn `ObjectStore`'s syncing with parent `DataRowStore` on or off basing on `RuntimeProperties`.
DefaultProcedureTranslator
A `ProcedureTranslator` returned by the base `JdbcAdapter`.
DefaultQuotingStrategy
An `QuotingStrategy` that wraps identifiers in a pair of (possibly distinct) start/end quote characters.
DefaultRowReaderFactory
DefaultRuntimeProperties
An implementation of `RuntimeProperties` that returns properties that were injected via a map in constructor.
DefaultScalarResultSegment
DefaultScope
An implementation of a DI scopes with support scope events.
DefaultScopeProvider<T>
A provider that provides scoping for other providers.
DefaultSelectTranslator
A `SelectTranslator` that translates a `FluentSelect` by running the `TranslationStage` pipeline over a `SelectTranslatorContext`.
DefaultSQLAppendable
DefaultSQLTemplateTranslator
DefaultTemplateContextFactory
DefaultTransactionFactory
DefaultTransactionManager
DefaultTransactionManager.BaseTransactionHandler
DefaultValueComparisonStrategyFactory
DefaultValueObjectTypeRegistry
Default implementation of `ValueObjectTypeRegistry`
DeferredValue
A 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.
DeleteBatchQuery
Batched delete query.
DeleteBatchTranslator
DeleteBuilder
DeleteDbRowOp
DeleteDbRowOpFactory
A factory of delete row ops used by the commit pipeline.
DeleteDenyException
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.
DeleteInsertDbRowOp
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).
DeleteNode
DeleteRule
Defines constants for the possible values of ObjRelationship delete rules.
DeleteRuleUpdater
DeleteRuleUpdater is responsible for auto-setting delete rules for object relationships
DepthFirstSearch<E>
DepthFirstStampSearch<E>
DerbyActionBuilder
DerbyAdapter
DbAdapter implementation for the Derby RDBMS
DerbyEJBQLConditionTranslator
DerbyEJBQLTranslator
DerbyPkGenerator
PK generator for Derby that uses sequences.
DerbySelectAction
DerbySniffer
Creates a DerbyAdapter if Apache Derby database is detected.
DerbySQLTreeProcessor
DerbyValueNode
DIBootstrap
A class that bootstraps the Cayenne DI container.
DICollectionBuilder<K,E>
A superclass of DI List and Map builders.
Digraph<E,V>
DigraphIteration<E,V>
Directive
DIRuntimeException
A runtime exception thrown on DI misconfiguration.
DistinctNode
DistinctResultIterator<T>
A ResultIterator that does in-memory filtering of rows to return only distinct rows.
DomainStoppedException
An exception thrown on attempts to access a DataDomain after it was explicitly shut down by the user.
DoubleType
DriverDataSource
A non-pooling DataSource implementation wrapping a JDBC driver.
DurationType
EffectiveOpId
Helper value-object class that used to compare operations by "effective" id (i.e. by id snapshot, that will include replacement id if any).
EJBQL
EJBQL.EJBQLDefaultParser
EJBQLAbs
EJBQLAbstractSchemaName
EJBQLAction
Parses an EJBQL statement, converting it to SQL.
EJBQLAdd
EJBQLAggregate
EJBQLAggregateColumn
An aggregate column expression.
EJBQLAll
EJBQLAnd
EJBQLAny
EJBQLAscending
EJBQLAverage
EJBQLBaseVisitor
A noop implementation of the EJBQL visitor that returns same preset boolean value from all methods.
EJBQLBetween
EJBQLBooleanLiteral
EJBQLClassName
EJBQLCompiledExpression
Represents an EJB QL expression "compiled" in the context of a certain mapping.
EJBQLConcat
EJBQLConditionTranslator
EJBQLConstants
Token literal values and constants.
EJBQLConstructor
EJBQLConstructorParameter
EJBQLConstructorParameters
EJBQLCount
EJBQLCurrentDate
EJBQLCurrentTime
EJBQLCurrentTimestamp
EJBQLDbPath
EJBQLDbPathTranslator
EJBQLDecimalLiteral
EJBQLDelete
EJBQLDeleteTranslator
A translator of EJBQL DELETE statements into SQL.
EJBQLDescending
EJBQLDistinct
EJBQLDivide
EJBQLEquals
EJBQLEscapeCharacter
EJBQLException
An exception thrown on errors during parsing EJBQL statements.
EJBQLExists
EJBQLExpression
An abstract EJBQL expression interface.
EJBQLExpressionVisitor
A visitor interface to inspect the EJBQL expression tree.
EJBQLFrom
EJBQLFromItem
EJBQLFromTranslator
EJBQLGreaterOrEqual
EJBQLGreaterThan
EJBQLGroupBy
EJBQLHaving
EJBQLIdentificationVariable
EJBQLIdentifier
EJBQLIn
EJBQLInnerFetchJoin
EJBQLInnerJoin
EJBQLIntegerLiteral
EJBQLIsEmpty
EJBQLIsNull
EJBQLJoin
EJBQLJoinAppender
Handles appending joins to the content buffer at a marked position.
EJBQLLength
EJBQLLessOrEqual
EJBQLLessThan
EJBQLLike
EJBQLLocate
EJBQLLower
EJBQLMax
EJBQLMemberOf
EJBQLMin
EJBQLMod
EJBQLMultiColumnOperand
A holder of multi-column match condition operand.
EJBQLMultiply
EJBQLNamedInputParameter
EJBQLNegative
EJBQLNot
EJBQLNotEquals
EJBQLOr
EJBQLOrderBy
EJBQLOrderByItem
EJBQLOuterFetchJoin
EJBQLOuterJoin
EJBQLParser
An abstract definition of EJBQL query parser.
EJBQLParserFactory
Creates `EJBQLParser` based on the system settings.
EJBQLPath
EJBQLPathTranslator
A translator that walks the relationship/attribute path, appending joins to the query.
EJBQLPatternValue
EJBQLPositionalInputParameter
EJBQLQuery
An EJBQL query representation in Cayenne.
EJBQLQueryDescriptor
EJBQLSelect
EJBQLSelectClause
EJBQLSelectColumnsTranslator
Translator of the EJBQL select clause.
EJBQLSelectExpression
EJBQLSelectExpressions
EJBQLSelectTranslator
A translator of EJBQL SELECT statements into SQL.
EJBQLSize
EJBQLSqrt
EJBQLStringLiteral
EJBQLSubselect
EJBQLSubstring
EJBQLSubtract
EJBQLSum
EJBQLTok
EJBQLTokenManager
Token Manager.
EJBQLTranslationContext
A context used for translating of EJBQL to SQL.
EJBQLTranslator
A stateless service that produces translation visitors of EJBQL.
EJBQLTreeConstants
EJBQLTrim
EJBQLTrimBoth
EJBQLTrimCharacter
EJBQLTrimLeading
EJBQLTrimSpecification
EJBQLTrimTrailing
EJBQLUpdate
EJBQLUpdateField
EJBQLUpdateItem
EJBQLUpdateValue
EJBQLUpper
EJBQLWhere
ElseNode
Embeddable
A mapping descriptor of an embeddable class.
EmbeddableAttribute
A persistent attribute of an embeddable object.
EmbeddableAttributeHandler
EmbeddableDescriptor
EmbeddableHandler
EmbeddableObject
EmbeddableProperty<E>
Property that represents object attribute mapped on `Embeddable` object.
EmbeddableResultSegment
EmbeddedAttribute
An attribute of the ObjEntity that maps to an embeddable class.
EmbeddedFieldAccessor
An accessor for fields storing embedded objects.
EmbeddedResult
A metadata object that provides mapping of a set of result columns to an Embeddable object.
EmptyConfigurationNodeVisitor
EmptyNode
Entity<E,A,R>
An Entity is an abstract descriptor for an entity mapping concept.
EntityInheritanceTree
A tree structure representing inheritance hierarchy of an ObjEntity and its subentities.
EntityMergeListener
EntityMergeListener interface defines API useful for listening to EntityMergeSupport processing.
EntityProperty<E>
Property that represents to-one relationships.
EntityResolver
Represents a virtual shared namespace for zero or more DataMaps.
EntityResult
A metadata object that provides mapping of a set of result columns to an ObjEntity.
EntityResultSegment
A "compiled" version of a `EntityResult` descriptor.
EntitySorter
Defines API for sorting of Cayenne entities based on their mutual dependencies.
EntitySorterFactory
Creates `EntitySorter` instances.
EnumType<T>
An ExtendedType that handles an enum class.
EnumTypeFactory
ExtendedTypeFactory for handling Enum types.
EqualNode
EqualsBuilder
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.
EvaluatedBitwiseNode
EvaluatedMathNode
EvaluatedNode
EventBridge
An object that passes events between a local EventManager and some other event dispatch mechanism.
EventBridgeFactory
Defines a factory to dynamically create EventBridge instances.
EventManager
This class 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).
EventManagerProvider
EventSubject
This class encapsulates the String that is used to identify the subject that a listener is interested in.
EventUtil
Contains access stack events related utility methods.
ExistsNode
Expression
Superclass of Cayenne expressions that defines basic API for expressions use.
ExpressionException
RuntimeException thrown on errors during expressions creation/parsing.
ExpressionFactory
Helper class to build expressions.
ExpressionNode
ExpressionNode
ExpressionNodeBuilder
ExpressionParameter
Named parameter for parameterized expressions.
ExpressionParser
Parser of Cayenne Expressions.
ExpressionParserConstants
Token literal values and constants.
ExpressionParserTokenManager
Token Manager.
ExpressionParserTreeConstants
ExtendedEnumeration
An interface that Enum classes may implement to map enum instances to arbitrary DB values that do not match the enum names or positions.
ExtendedEnumType<T>
An ExtendedType that handles a Java Enum based upon the Cayenne ExtendedEnumeration interface.
ExtendedType<T>
Defines methods to read Java objects from JDBC ResultSets and write as parameters of PreparedStatements.
ExtendedTypeFactory
ExtendedType factory interface.
ExtendedTypeMap
Stores ExtendedTypes, implementing an algorithm to determine the right type for a given Java class.
ExternalTransaction
Represents a container-managed transaction.
Fault
Represents a placeholder for an unresolved relationship from a source object.
FaultFactory
FaultFailureException
A runtime exception thrown when during lazy object initialization Cayenne finds that no matching row exists in the database for a given ObjectId.
FieldAccessor
A PropertyAccessor that performs direct Field access.
FieldEmbeddableDescriptor
A default POJO embeddable descriptor.
FilterArcIterator<E,V>
FilterIteration<E,V>
FirebirdActionBuilder
FirebirdAdapter
DbAdapter implementation for the FirebirdSQL RDBMS
FirebirdEJBQLConditionTranslator
FirebirdEJBQLTranslator
FirebirdLimitNode
FirebirdSelectAction
FirebirdSniffer
FirebirdSQLTreeProcessor
FirebirdSubstringFunctionNode
SUBSTRING function for Firebird It has following format: SUBSTRING (string FROM CAST(?
FloatType
FluentSelect<T,S>
Base class for `ObjectSelect` and `ColumnSelect`
FluentSelectWrapper
FromNode
FrontBaseActionBuilder
An action builder for FrontBaseActionBuilder.
FrontBaseAdapter
DbAdapter implementation for FrontBase RDBMS
FrontBasePkGenerator
FrontBaseSniffer
FrontBaseSQLTreeProcessor
FrontBaseTemplateAction
FunctionExpressionFactory
Collection of factory methods to create function call expressions.
FunctionNode
FunctionNodeBuilder
GenericPersistentObject
Implementation of `Persistent` that uses `Map` to store object fields.
GenericQueryResult<T>
Generic implementation of QueryResult using List as QueryResultItem storage.
GenericResponse
A simple serializable implementation of QueryResponse.
GeoJson
A Cayenne-supported values object that holds GeoJson string.
GeoJsonType
GraphBasedDbRowOpSorter
Db operation sorted that builds dependency graph and uses topological sort to get final order.
GraphChangeHandler
Defines callback API that can be used by object graph nodes to notify of their state changes.
GraphDiff
Represents a change in an object graph.
GraphDiffCompressor
A utility class that removes redundant and mutually exclusive graph changes from the graph diff.
GraphEvent
An event indicating a change in the object graph.
GraphManager
Represents a generic "managed" graph with nodes mapped by their ids.
GraphMap
A base implementation of GraphManager that stores graph nodes keyed by their ids.
GroupByNode
H2ActionBuilder
H2Adapter
DbAdapter implementation for H2 RDBMS.
H2CharType
H2 specific char type handling - used to handle the correct setting of clobs
H2EJBQLConditionTranslator
H2EJBQLTranslator
H2PkGenerator
Default PK generator for H2 that uses sequences for PK generation.
H2SelectAction
H2Sniffer
H2SQLTreeProcessor
H2TrimmingColumnNode
HandlerFactory
Factory that creates handlers for unparsed elements.
HardDeleteDbRowOpFactory
Default implementation of `DeleteDbRowOpFactory` producing plain `DeleteDbRowOp` that translate to SQL DELETE.
HashCodeBuilder
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)` loop
HavingNode
HSQLDBAdapter
DbAdapter implementation for the HSQLDB RDBMS.
HSQLDBProcedureTranslator
Works around HSQLDB's pickiness about stored procedure syntax.
HSQLDBSniffer
Detects HSQLDB database from JDBC metadata.
HSQLEJBQLConditionTranslator
HSQLEJBQLTranslator
HSQLTreeProcessor
HybridPersistentObject
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.
IdentifierNode
IdMapKeyAccessor
A stateless read-only accessor of the map key value that is based on the Persistent object id.
IdProperty<E>
Base class for properties mapped to PK
IDUtil
helper class to generate pseudo-GUID sequences.
IncludeAllCommitLogEntityFactory
IncrementalFaultList<E>
A synchronized list that serves as a container of Persistent objects.
IncrementalListResponse
A QueryResponse that contains a sublist of the query result.
IndegreeTopologicalSort<E>
IndexPropertyList
A List implementation that would maintain its internal ordering based on some object numeric "index" property.
IndirectQuery
A base superclass for queries that resolve into some other queries during the routing phase.
IngresActionBuilder
IngresAdapter
DbAdapter implementation for Ingres RDBMS.
IngresBooleanType
IngresPkGenerator
Ingres-specific sequence based PK generator.
IngresSelectAction
IngresSniffer
Detects Ingres database from JDBC metadata.
IngressSQLTreeProcessor
Inject
Injector
A facade to the Cayenne DI container.
InNode
InsertBatchQuery
Batched INSERT query.
InsertBatchTranslator
InsertBuilder
InsertColumnsNode
InsertDbRowOp
InsertNode
InsertValuesNode
IntegerType
InternalUnsupportedTypeFactory
Extended type factory that produces types for Cayenne internal value types that could potentially make it to the DB.
InternalUnsupportedTypeFactory.Marker
Marker interface, that should be used by any internal value types, that could potentially get to the SQL
Invocation
Invocation represents a dynamic method invocation bound to a specific target.
IteratedQueryDecorator
A simple decorator for an iterated query.
JavaCharStream
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (with java-like unicode escape processing).
JavaCharStream
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (with java-like unicode escape processing).
JavaCharStream
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (with java-like unicode escape processing).
JdbcActionBuilder
A factory of default SQLActions.
JdbcAdapter
A generic DbAdapter implementation.
JdbcEJBQLTranslator
A default `EJBQLTranslator`.
JdbcPkGenerator
Default primary key generator implementation.
JJTEJBQLState
JJTExpressionParserState
JJTSQLTemplateParserState
JoinNode
JoinNodeBuilder
JoinType
JoinType
Enumerates supported JOIN types.
Json
A Cayenne-supported values object that holds Json string.
JsonType
JsonUtils
Simple utils to process JSON.
Key<T>
An object that encapsulates a key used to store and lookup DI bindings.
LazyClassDescriptorDecorator
A ClassDescriptor wrapper that compiles decorated descriptor lazily on first access.
LifecycleCallbackRegistry
A registry of lifecycle callbacks for all callback event types.
LifecycleEvent
Defines possible entity object lifecycle events.
LifecycleListener
A callback interface to listen to persistent object lifecycle events.
LikeNode
expressions: LIKE, ILIKE, NOT LIKE, NOT ILIKE + ESCAPE
LimitOffsetNode
LimitResultIterator<T>
ListBuilder<T>
A binding builder for list configurations.
ListProperty<V>
Property that represents to-many relationship mapped on `List`.
ListResponse
A QueryResponse optimized to hold a single object or data row list.
LoaderContext
LocalDateTimeValueType
LocalDateValueType
LocalizedStringsHandler
Provides access to various modeler resources (mainly strings) obtained via a ResourceBundle.
LocalTimeValueType
LongType
MalformedJsonException
ManagedPoolingDataSource
A wrapper for `UnmanagedPoolingDataSource` that automatically manages the underlying connection pool size.
MapAccessor
MapBuilder<T>
A binding builder for map configurations.
MapDigraph<E,V>
MappedExec
A query that represents a named parameterized non selecting query stored in the mapping.
MappedSelect<T>
A query that represents a named parameterized selecting query stored in the mapping.
MappingNamespace
Defines API of a container of DbEntities, ObjEntities, Procedures, Queries and other mapping objects.
MapProperty<K,V>
Property that represents to-many relationship mapped on `Map`.
MapQueryCache
A default implementation of the `QueryCache` interface that stores data in a non-expiring LRUMap.
MapQueryCacheProvider
MariaDBSniffer
MemoryBlob
A Blob implementation that stores content in memory.
MemoryClob
A Clob implementation that stores contents in memory.
Module
Represents a unit of configuration of the Cayenne DI container.
ModuleLoader
Auto-loads DI modules using ServiceLoader.
ModuleProvider
Provider of modules used by module auto-loading mechanism to identify and load modules.
MutableAttributeChange
MutableChangeMap
A mutable implementation of `ChangeMap`.
MutableCommitLogLogEntity
MutableObjectChange
A mutable implementation of `ObjectChange`.
MutableToManyRelationshipChange
MutableToOneRelationshipChange
MySQLAdapter
DbAdapter implementation for MySQL RDBMS.
MysqlLikeNode
MysqlLimitOffsetNode
MySQLPkGenerator
MySQLProcedureTranslator
A translator that adds parenthesis to no-param queries.
MySQLSniffer
Detects MySQL database from JDBC metadata.
MySQLTreeProcessor
NamespaceAwareNestedTagHandler
Base class for handlers that can delegate execution of unknown tags to handlers produced by factory.
NativeColumnType
Describes a single database-native (external) SQL type that a JDBC type (see `Types`) maps to.
NegateNode
Unary minus.
NestedQueryCache
A `QueryCache` wrapper that introduces a key namespace on top of a delegate shared cache.
Node
Node
All AST nodes must implement this interface.
Node
A JJTree-compliant tree node interface.
Node
Provides basic machinery for constructing the parent and child relationships between nodes.
NodeBuilder
NodeCreateOperation
NodeDeleteOperation
NodeDiff
An abstract superclass of operations on individual nodes and arcs in a digraph.
NodeIdChangeOperation
A GraphDiff representing a change in node ID.
NodePropertyChangeOperation
NodeTreeVisitor
NodeType
NoopDataChannelMetaData
Noop implementation of `DataChannelMetaData`.
NoopEventBridge
NoopEventBridgeProvider
NoopEventManager
NoopSQLLogger
A no-op `SQLLogger`.
NoSyncObjectStore
An `ObjectStore` which doesn't receive notifications on parent's `DataRowStore` events.
NotEqualNode
NotNode
NumericIdProperty<E>
Property that represents numeric PK
NumericProperty<E>
Property that represents attributes mapped on numeric types
ObjAttribute
An ObjAttribute is a mapping descriptor of a Java class property.
ObjectChange
Accumulates changes of a single object with a transaction.
ObjectChangeType
Defines types of tracked object changes.
ObjectContext
A Cayenne object facade to a persistent store.
ObjectContextFactory
A factory for regular and nested contexts.
ObjectDiff
A dynamic GraphDiff that represents a delta between object simple properties at diff creation time and its current state.
ObjectId
A portable global identifier for persistent objects.
ObjectIdQuery
A query that matches zero or one object or data row corresponding to the ObjectId.
ObjectMapRetainStrategy
A strategy for retaining objects in `ObjectStore`.
ObjectSelect<T>
A selecting query providing chainable API.
ObjectStore
ObjectStore stores objects using their ObjectId as a key.
ObjectStoreFactory
A factory for creating `ObjectStore`s.
ObjectStoreGraphDiff
A GraphDiff facade for the ObjectStore changes.
ObjectType
This is a default ExtendedType that relies on JDBC driver to determine the result type.
ObjEntity
ObjEntity is a mapping descriptor for a Persistent Java class.
ObjEntityHandler
ObjRelationship
Describes an association between two Java classes mapped as source and target ObjEntity.
ObjRelationshipHandler
OffsetFetchNextNode
OffsetNode
OperationHints
Defines API that allows a DataNode to obtain information about query execution strategy.
OperationObserver
Defines a set of callback methods that allow `DataNode` to pass back query results and notify caller about exceptions.
OpExpressionNode
OpIdFactory
Factory that wraps provided ID to be suitable for the better processing in the flush operation.
OptimisticLockException
An exception thrown on optimistic lock failure.
OracleAdapter
DbAdapter implementation for Oracle RDBMS
OracleByteArrayType
OracleCharType
Oracle specific CHAR type handling.
OraclePkGenerator
Sequence-based primary key generator implementation for Oracle.
OracleSniffer
OracleSQLTreeProcessor
OracleUtilDateType
OrderByNode
Ordering
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.
OrderingNodeBuilder
Orderings
Orderings is provided so that you can chain Ordering together and then use the result to pass into methods that require List<Ordering>
ParameterizedQuery
Defines a query that can serve as a template for other queries.
ParseException
This exception is thrown when parse errors are encountered.
ParseException
This exception is thrown when parse errors are encountered.
ParseException
This exception is thrown when parse errors are encountered.
PathComponent<A,R>
A component in a path chain.
PathProperty<E>
Property that represents path segment (relationship or embeddable).
PatternMatchNode
Superclass of pattern matching nodes.
PerAdapterProvider<T>
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
PerAttributeChildProcessor<T>
PeriodValueType
PersistenceState
Defines a set of object states from the point of view of persistence.
Persistent
Defines minimal API of an object that can be persisted via Cayenne.
PersistentDescriptor
A default ClassDescriptor implementation for persistent objects.
PersistentDescriptorFactory
A convenience superclass for `ClassDescriptorFactory` implementors.
PersistentObject
Base implementation of `Persistent`, have no assumption about how data is actually stored.
PersistentObjectCollection<E>
Simple interface to unify PersistentObject* collections in way of setting properties directly
PersistentObjectDescriptorFactory
A `ClassDescriptorFactory` that creates descriptors for classes implementing `Persistent`.
PersistentObjectHolder<E>
A ValueHolder implementation that holds a single Persistent object related to an object used to initialize PersistentObjectHolder.
PersistentObjectList<E>
A list of persistent objects lazily resolved on the first access.
PersistentObjectMap
PersistentObjectSet<E>
PkGenerator
Defines methods to support automatic primary key generation.
PojoMapper<T>
Simple mapper of Object[] to a POJO class.
PoolAwareConnection
A Connection wrapper that interacts with the UnmanagedPoolingDataSource, allowing to recycle connections and track failures.
PoolingDataSourceBuilder
Deprecated, for removal: This API element is subject to removal in a future version.
in favor of `CayenneDataSource`
PoolingDataSourceParameters
A collection of pooling parameters used by `UnmanagedPoolingDataSource`.
PositionFunctionNode
PostAdd
An annotation to place on the entity event listener method to receive `LifecycleEvent.POST_ADD` events.
PostgresAdapter
DbAdapter implementation for PostgreSQL RDBMS
PostgresBatchAction
PostgresExtractFunctionNode
PostgresLikeNode
PostgresLimitOffsetNode
PostgresPkGenerator
Default PK generator for PostgreSQL that uses sequences for PK generation.
PostgresProcedureTranslator
A translator that adds parenthesis to no-param queries.
PostgreSQLTreeProcessor
PostgresSniffer
PostLoad
An annotation to place on the entity event listener method to receive `LifecycleEvent.POST_LOAD` events.
PostPersist
An annotation to place on the entity event listener method to receive `LifecycleEvent.POST_PERSIST` events.
PostRemove
An annotation to place on the entity event listener method to receive `LifecycleEvent.POST_REMOVE` events.
PostUpdate
An annotation to place on the entity event listener method to receive `LifecycleEvent.POST_UPDATE` events.
PrefetchProcessor
A hierarchical visitor interface for traversing a tree of PrefetchTreeNodes.
PrefetchSelectQuery<T>
A SelectQuery to perform a prefetch based on another query.
PrefetchTreeNode
Defines a node in a prefetch tree.
PrePersist
An annotation to place on the entity event listener method to receive `LifecycleEvent.PRE_PERSIST` events.
PreRemove
An annotation to place on the entity event listener method to receive `LifecycleEvent.PRE_REMOVE` events.
PreUpdate
An annotation to place on the entity event listener method to receive `LifecycleEvent.PRE_UPDATE` events.
Procedure
A mapping descriptor for a database stored procedure.
ProcedureAction
A SQLAction that runs a stored procedure.
ProcedureCall<T>
Fluent API for calling stored procedures.
ProcedureColumn
An adapter-independent description of a single column in a `ProcedureQuery` result set.
ProcedureHandler
ProcedureParameter
A descriptor for the Procedure parameter.
ProcedureQuery
A query based on Procedure.
ProcedureQueryDescriptor
ProcedureResult<T>
Result of procedure call.
ProcedureResultBuilder<T>
ProcedureTranslator
A service that translates a `ProcedureQuery` into a `TranslatedProcedure`.
Property<E>
Base interface for all types of properties
PropertyAccessor
A utility accessor class that wraps a simple property.
PropertyChange
A base interface for various types of property changes.
PropertyChangeVisitor<T>
PropertyDescriptor
Defines bean property API used by Cayenne to access object data, do faulting and graph maintenance tasks.
PropertyException
An unchecked exception thrown on errors during property access, either within a Accessor or a Property.
PropertyFactory
Factory class that produces all property types.
PropertyUtils
Utility methods to quickly access object properties.
PropertyVisitor
A visitor for various types of properties in a ClassDescriptor.
Provider<T>
A DI object factory interface.
PSBatchParameter
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.
PSParameter<T>
Describes a single immutable PreparedStatement parameter binding.
Qualifier
Qualifier of DB row.
Query
Defines minimal API of a query descriptor that is executable via Cayenne.
QueryCache
Defines API of a cache that stores query results.
QueryCacheEntryFactory
A factory that is used by the cache to rebuild expired entries.
QueryCacheStrategy
Defines query result caching policy.
QueryChain
A Query decorator for a collection of other queries.
QueryDescriptor
Generic descriptor of a Cayenne query.
QueryDescriptorHandler
QueryDescriptorLoader
A builder that constructs Cayenne queries from abstract configuration information defined in cayenne-data-map*.dtd.
QueryMetadata
Provides a common interface for accessing query metadata.
QueryMetadataProxy
QueryResponse
Represents a result of query execution.
QueryResult<T>
Represents a collection of items which are results of a multipart query execution.
QueryResultBuilder
QueryResultItem<T>
Represents a single item in a multipart query execution.
QueryRouter
An interface used by Queries to route themselves to an appropriate DataNode.
QuotingStrategy
Encapsulates a database-specific SQL identifier quoting style (the start and end quote characters).
ReadOnlyTransaction
A minimal `Transaction` for read-only (selecting) queries that run outside a managed transaction.
RefreshQuery
A query that allows to explicitly clear both object and list caches either via refetch (eager refresh) or invalidate (lazy refresh).
Relationship<E,A,R>
Defines a relationship between two entities.
RelationshipFault<E>
An abstract superclass of lazily faulted to-one and to-many relationships.
RelationshipProperty<E>
Interface (or "Trait") that provides basic functionality for all types of relationships.
RelationshipQuery
A query that selects objects related to a given object via a mapped relationship.
Resource
An abstraction of a resource whose data can be accessed via a URL.
ResourceLocator
Result
ResultBatchIterator<T>
Defines API of a batch iterator over the ResultIterator returned as a result of Select queries execution.
ResultIterator<T>
Defines API of an iterator over the records returned as a result of selecting queries execution.
ResultIteratorCallback<T>
A callback interface invoked on each row when iterating over `ResultIterator`.
ResultIteratorIterator<T>
ReversedIteration<E,V>
ReversedIteration.ReversedArcIterator<S,T>
RootDataMapHandler
RowReader<T>
A strategy class that encapsulates an algorithm for converting a single ResultSet row into a DataRow.
RowReaderFactory
Creates RowReader instances for executed queries.
RSColumn
A descriptor of a ResultSet column.
RSColumn.RowBuilder
RSIterator<T>
A ResultIterator over a JDBC ResultSet.
RuntimeProperties
Represents a properties map for a given `CayenneRuntime`.
SAXNestedTagHandler
A superclass of nested tag handlers for parsing of XML documents with SAX.
ScalarNode<V>
ScalarResultSegment
SchemaUpdateStrategy
A strategy for auto generating a database schema on the application startup.
Scope
Defines the scope of the instances created by the DI container.
ScopeEventBinding
A class that wraps an annotated method call of an object, passing it DI scope events.
ScopeEventListener
This interface duplicates default reflection based mechanism for receiving DI events.
Select<T>
A common interface for grouping together different kinds of queries that return results.
SelectAction
A SQLAction that handles SelectQuery execution.
SelectBuilder
SelectById<T>
A query to select objects by id.
SelectById.IdSpec
SelectById.MultiMapIdSpec
SelectById.MultiScalarIdSpec
SelectById.QueryRoot
SelectById.SingleMapIdSpec
SelectById.SingleScalarIdSpec
SelectNode
SelectQueryDescriptor
SelectResultNode
SelectTranslator
A service that translates a `Select` query into a `TranslatedSelect`.
SelfProperty<E>
Property that represents root entity
SequencePkGenerator
A common superclass for sequence-based primary key generators.
ServerRuntime
Deprecated, for removal: This API element is subject to removal in a future version.
use `CayenneRuntime` class instead
SetProperty<V>
Property that represents to-many relationship mapped on `Set`.
ShallowMergeOperation
An operation that merges changes from a single object registered in some ObjectContext, to a peer object in an ObjectConext that is a child of that context.
ShortType
Handles `java.lang.Short` type mapping.
SimpleAttributeProperty
A descriptor of an "attribute" persistent property.
SimpleNode
SimpleNode
A base node for the EJBQL concrete nodes that satisfies JJTree requirements.
SimpleNode
Superclass of AST* expressions that implements Node interface defined by JavaCC framework.
SimpleNodeTreeVisitor
SimpleValidationFailure
Represents a generic validation failure that contains failed object and a message describing the failure.
SingleEntryMap<K,V>
Optimized mutable single-entry map.
SingletonFaultFactory
SkipSchemaUpdateStrategy
A SchemaUpdateStrategy that does nothing.
Slf4jSQLLogger
A `SQLLogger` that emits compact, single-line messages through slf4j-api under the fixed logger name `cayenne-sql`.
SnapshotEvent
Event sent on modification of the DataRowStore.
SnapshotEventListener
SoftDeleteDbRowOp
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.
SoftValueMap<K,V>
Map that stores values wrapped into `SoftReference`
SortOrder
Constants to order query results (the ORDER BY clause).
SortWeight
An annotation that defines the insertion sorting "weight" of an entity that is used when sorting DB operations.
SQLAction
Defines API for query execution strategy over JDBC connection (as in Strategy Pattern).
SQLActionVisitor
A factory interface to create standard SQLActions for a set of standard queries.
SQLAppendable
SQLBuilder
SQLExec
A generic query based on raw SQL and featuring fluent API.
SQLGenerationContext
SQLGenerationVisitor
SQLiteAdapter
A SQLite database adapter.
SQLiteSelectAction
SQLiteSniffer
Detects SQLite database from JDBC metadata.
SQLiteTreeProcessor
SQLLogger
A logging service used by Cayenne to output database interactions as compact, single-line messages.
SQLResult
A metadata object that defines how a row in a result set can be converted to result objects.
SQLResultStage
SQLSelect<T>
A selecting query based on raw SQL and featuring fluent API.
SQLServerActionBuilder
SQLServerAdapter
Cayenne DbAdapter implementation for Microsoft SQL Server RDBMS.
SQLServerBatchAction
SQLServerColumnNode
SQLServerLimitOffsetNode
SQLServerPkGenerator
Primary key generator implementation for Sybase.
SQLServerProcedureAction
ProcedureAction for SQLServer MS JDBC driver.
SQLServerSelectAction
SQLServerSniffer
Detects SQLServer database from JDBC metadata.
SQLServerTreeProcessor
SQLServerTreeProcessorV12
SQL tree processor that supports OFFSET X ROWS FETCH NEXT Y ROWS ONLY clause for the SQLServer 2012 and later.
SQLTemplate
A query that executes unchanged (except for template preprocessing) "raw" SQL specified by the user.
SQLTemplateAction
Implements a strategy for execution of SQLTemplates.
SQLTemplateDescriptor
SQLTemplateMetadata
SQLTemplateParser
Parser of Cayenne Templates.
SQLTemplateParserConstants
Token literal values and constants.
SQLTemplateParserTokenManager
Token Manager.
SQLTemplateParserTreeConstants
SQLTemplateRenderingUtils
Implements utility methods used inside Velocity templates when rendering SQLTemplates.
SQLTemplateTranslator
SQLTreeProcessor
StringProperty<E>
Property that represents attributes mapped on string types
StrongConnection<E,V>
SubqueryNode
SybaseAdapter
DbAdapter implementation for Sybase RDBMS.
SybasePkGenerator
Primary key generator implementation for Sybase.
SybaseSniffer
Detects Sybase database from JDBC metadata.
SybaseSQLTreeProcessor
TableNode
TableNodeBuilder
TemplateContextFactory
TextNode
ThenNode
ThrowOnPartialOrCreateSchemaStrategy
ThrowOnPartialSchemaStrategy
TimestampType
TimeType
ToAnyConverter<T>
Can convert to any class that has a constructor that takes a single Object or a single String parameter.
Token
Describes the input token stream.
Token
Describes the input token stream.
Token
Describes the input token stream.
TokenMgrError
Token Manager Error.
TokenMgrError
Token Manager Error.
TokenMgrError
Token Manager Error.
ToManyList<E>
A list that holds objects for to-many relationships.
ToManyListFault
ToManyMapFault
ToManyMapProperty
A property representing a map of objects keyed by one of the object properties.
ToManyProperty
A property representing a collection of objects.
ToManyRelationshipChange
Represents a change in a to-many relationship property to another entity.
ToManySet<E>
ToManySetFault
ToOneFault
ToOneProperty
An ArcProperty that points to a single graph node.
ToOneRelationshipChange
TopNode
ToStringBuilder
A utility class to simplify implementation of Object toString methods.
Transaction
Cayenne Transaction interface.
TransactionalOperation<T>
TransactionDescriptor
Descriptor that allows to customize transaction logic.
TransactionDescriptor.Builder
Builder class for the TransactionDescriptor.
TransactionFactory
TransactionFilter
A `DataChannelSyncFilter` that provides transactions.
TransactionListener
A callback that is notified as transaction progresses through stages.
TransactionManager
An optional utility service that simplifies wrapping multiple operations in transactions.
TransactionPropagation
Propagation behavior of transaction
TranslatableQueryWrapper
This interface allows transparently use different queries (namely SelectQuery, ObjectSelect and ColumnSelect) in translator and as subqueries.
TranslatedBatch
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.
TranslatedProcedure
An immutable result of translating a `ProcedureQuery` to a stored procedure call.
TranslatedSelect
An immutable result of translating a `Select` query to SQL, produced by `SelectTranslator.translate(Select, DbAdapter, EntityResolver)`.
TranslatedSQL
A translated form of a Query used to generated PreparedStatements.
TranslatedStatement
A common supertype for the immutable results of translating a query to SQL.
TraversalHandler
Expression visitor interface.
TraversalHelper
Deprecated, for removal: This API element is subject to removal in a future version.
as `TraversalHandler` has default no-op implementations for all methods
TrimmingColumnNode
TypeAwareSQLTreeProcessor
TypesMapping
A utility class that handles mappings of JDBC data types to the database types and Java types.
UnmanagedPoolingDataSource
A non-blocking `DataSource` with a pool of connections.
UnmanagedPoolingDataSource.ConnectionUnavailableException
An exception indicating that a connection request waiting in the queue timed out and was unable to obtain a connection.
UnresolvablePathException
A runtime exception thrown when `PropertyUtils.getProperty()` finds that there is a null value in middle of the resolved path.
UpdateBatchQuery
Batched UPDATE query.
UpdateBatchTranslator
UpdateBuilder
UpdateDbRowOp
UpdateNode
UpdateSetNode
URLResource
A `Resource` implementation wrapping a resource URL.
Util
Contains various unorganized static utility methods used across Cayenne.
UtilDateType
Maps `java.util.Date` to any of the three database date/time types: TIME, DATE, TIMESTAMP.
UUIDValueType
Validating
Defines a number of callback methods that allow an object to be validated before safe.
ValidationException
An exception thrown on unsuccessful validation.
ValidationFailure
Defines a single failure during the validation process.
ValidationResult
Represents a result of a validation execution.
ValueComparisonStrategy<V>
ValueComparisonStrategyFactory
ValueHolder<E>
Provides a level of indirection for property value access, most often used for deferred faulting of to-one relationships.
ValueHolderDescriptorFactory
A `ClassDescriptorFactory` for Persistent objects that implement relationship faulting via `ValueHolder`.
ValueInjector
Describes expressions, that can "inject" value to an object, i.e. do something reverse to "match" method.
ValueNode
ValueNodeBuilder
ValueObjectType<V,T>
Descriptor and serialization helper for custom value objects that can be safely stored in the DB.
ValueObjectTypeFactory
ValueObjectTypeRegistry
Registry of user-defined descriptors of custom value objects' classes.
Values
Collection of values that should be inserted or updated in DB.
VersionAwareHandler
Handler that can validate root tag name, version and namespace.
VoidType
A noop type that is sometimes useful to suppress extended types operations.
WeakValueMap<K,V>
Map that stores values wrapped into `WeakReference`
WeightedAshwoodEntitySorter
EntitySorter that takes into account entity "weights", and otherwise delegating to another (topological) sorter.
WhenNode
WhereNode
Wkt
A Cayenne-supported value object holding a WKT geometry String.
WktType
XMLDataChannelDescriptorLoader
XMLDataMapLoader
XMLEncoder
A helper class to encode objects to XML.
XMLReaderProvider
XMLSerializable
Interface for Cayenne objects that can be saved to XML.