Package jakarta.nosql.mapping

Defines the core API in mapping level.

See: Description

Interface Summary

Interface	Description
AttributeConverter<X,Y>	A class that implements this interface can be used to convert entity attribute state into database column representation and back again.
Converters	The Converter storage
EntityPostPersit	When an entity is either saved or updated it's the first event to fire after the database action.
EntityPrePersist	When an entity is either saved or updated it's the first event to fire
InstanceProducer	An instance producer from the Class
Page<T>	A page is a fixed-length contiguous block of entities from the database.
Pagination	Pagination is the process of separating print or digital content into discrete pages.
Pagination.PaginationBuilder	The builder of Pagination
Pagination.PaginationBuilderProvider	A provider of Pagination.PaginationBuilder where it will create from the Long value
PreparedStatement	An object that represents a precompiled Query statement.
Repository<T,K>	Interface to generic CRUD operations on a repository for a specific type.
Sorts	This instance represents a group of one or more Sort instances.
Sorts.SortsProvider	A provider class of Sorts
Template	Templates are a helper class that increases productivity when performing common NoSQL operations.

Enum Summary

Enum	Description
DatabaseType	Defines the database type supported on Jakarta NoSQL Mapping.

Exception Summary

Exception	Description
DynamicQueryException	The root exception to dynamic query on Repository
EntityNotFoundException	Thrown by the persistence provider when an entity does not exist.
IdNotFoundException	When The Entity is converted to communication layer, this entity must have a field with Id annotation.
MappingException	The root exception to Mapping layer

Annotation Types Summary

Annotation Type	Description
Column	Is used to specify a mapped column for a persistent property or field.
Convert	This annotation enables the converter resource.
Database	The database qualifier used on Jakarta NoSQL Mapping such as defines which interpreter will be used on Repository with Database
Embeddable	Defines an embedded field, that means all elements fields in the class will as converted as one.
Entity	Specifies that the class is an entity.
Id	This isn't a mandatory field, but when it define this field is a key.
MappedSuperclass	Designates a class whose mapping information is applied to the entities that inherit from it.
Param	Defines a param to a Query query.
Query	To run Query in Repository interface

Package jakarta.nosql.mapping Description

Defines the core API in mapping level. It brings an easy interface to support key-value, column family, document oriented and graph databases using as base Jakarta NoSQL in CDI based. The API's focus is on simplicity and ease of use.

• CDI Based
• Jakarta NoSQL Communication Based
• Events to insert, delete, update
• Supports to Bean Validation
• Annotation Driven Based
• Configurable and extensible

Developers should only have to know a minimal set of artifacts to work with the solution. The API is built on latest Java 8 features and therefore fit perfectly with the functional features of Java 8.