Uses of Interface
st.orm.Data
Packages that use Data
Package
Description
Foundation of the data model: the mapping annotations and the record interfaces.
Record mapping contracts.
Java repository API.
Java client API: templates, query builders and transactions.
Java client API implementation.
-
Uses of Data in st.orm
Modifier and TypeClassDescriptionclassAbstractKeyMetamodel<T extends Data,E, V extends @Nullable Object> Extension ofAbstractMetamodelthat implementsMetamodel.Key, indicating that the field has a uniqueness constraint.classAbstractMetamodel<T extends Data,E, V extends @Nullable Object> Implementation that is used by the generated models.classAbstractNavigableMetamodel<T extends Data,E> Base implementation for generated navigation-only metamodels — nodes that navigate the entity graph beyond aRefforeign key.interfaceA text column of asearchorsuggestwith the form a typed word matches it in.static final recordMatch.Anywhere<T extends Data>A word matches anywhere in the value:LOWER(column) LIKE LOWER('%word%').static final recordMatch.Exact<T extends Data>A word matches the whole value.static final recordMatch.Prefix<T extends Data>A word matches at the start of the value.static final recordMatch.WordStart<T extends Data>A word matches at the start of any word in the value: the value's start, or the text after a space or one of the punctuation characters that join or separate the words of a name, a hyphen, an apostrophe, an opening parenthesis, a slash, a colon, a period or a comma, somariematches "Anne-Marie" andbrien"O'Brien".interfaceThe metamodel provides type-safe references to entity fields for use in queries.static interfaceMetamodel.Key<T extends Data,E> Marker interface for metamodel fields that correspond to columns known to be unique.static final recordMetamodel.KeyDelegate<T extends Data,E> Delegating wrapper that adds theMetamodel.Keymarker to an existingMetamodelinstance.static final recordMetamodel.Outer<T extends Data,E> A path named in the query that encloses the subquery it is used in, seeMetamodel.outer(Navigable).interfaceThe navigational part of aMetamodel: everything needed to locate a field within the entity graph and use it in a query (filter, join, order, group, select), without exposing value extraction.interfaceRef records are used to represent reference to records, allowing them to be fetched from the database.final recordScrollable<T extends Data>A scroll request: an ordering, a window size, and the position to continue from.static final recordSqlFunction.Call<T extends Data,E> The call of a function on a path.interfaceTypedMetamodel<T extends Data,E, V extends @Nullable Object> AMetamodelthat also carries the declared component type of the field it represents.Modifier and TypeInterfaceDescriptioninterfaceEntity<ID>Optional marker interface for record-based entities.interfaceProjection<ID>Marker interface for record-based projections.Modifier and TypeMethodDescriptionReturns a match of a word anywhere in the value, the default ofsearch.Returns aanywherematch that takes the words in its form once one reaches the given length, and the whole input as the start of the value, ignoring case, before: a longer length keeps a column whose matches rank low, such as one of a related table, in its fallback until a word is long enough to match few rows, and0takes every word in its form.Returns the call of this function on the given path, which a query takes where it takes the path.Returns a match of a word as the whole value, with the column bare and the word lowered, which an ordinary index over a column that compares case-insensitively serves.Returns aexactmatch that takes words of at least the given length.Match.exactIgnoreCase(Navigable<T, String> path) Returns a match of a word as the whole value, ignoring case: the column lowered as well as the word, on any column, which an index overLOWER(column)serves, the index of a match anywhere or at a word start included.Match.exactIgnoreCase(Navigable<T, String> path, int minLength) Returns aexactIgnoreCasematch that takes words of at least the given length.static <T extends Data,E>
Metamodel.Key<T, E> Returns aKeyview of the given metamodel.<T extends Data>
@Nullable Scrollable<T> Window.next()Returns a typed scrollable for fetching the next window, ornullif the window is empty.Creates a new metamodel for the given root rootTable and path.Creates a detached ref instance for the given type and primary key.static <T extends Data>
Scrollable<T> Scrollable.of(Metamodel.Key<T, ?> key, int size) Creates a request for the first window, ordered by the key ascending.Names the column at the given path in the query that encloses the subquery being built, as the other side of a comparison of two columns:where(Visit_.pet.id, EQUALS, outer(Pet_.id))keeps the visits of the enclosing query's pet.Returns a match of a word as a prefix of the value, with the column bare and the word lowered, which an ordinary index over a column that compares case-insensitively serves.Returns aprefixmatch that takes words of at least the given length.Match.prefixIgnoreCase(Navigable<T, String> path) Returns a match of a word as a prefix of the value, ignoring case: the column lowered as well as the word, on any column, which an index overLOWER(column)serves, the index of a match anywhere or at a word start included.Match.prefixIgnoreCase(Navigable<T, String> path, int minLength) Returns aprefixIgnoreCasematch that takes words of at least the given length.<T extends Data>
@Nullable Scrollable<T> Window.previous()Returns a typed scrollable for fetching the previous window, ornullif the window is empty.Creates a new metamodel for the given record type.Returns a match of a word at the start of any word in the value, the default ofsuggest: the value's start, or the text after a space or a punctuation character that joins or separates words.Returns awordStartmatch that takes the words in its form once one reaches the given length, and the whole input as the start of the value, ignoring case, before: a longer length keeps a column whose matches rank low, such as one of a related table, in its fallback until a word is long enough to match few rows, and0takes every word in its form.Modifier and TypeMethodDescriptionNavigable.canonical()Returns the canonical metamodel for the field represented bythis.AbstractMetamodel.table()Returns the table that holds the column to which this metamodel is pointing.AbstractNavigableMetamodel.table()Metamodel.KeyDelegate.table()Metamodel.Outer.table()Metamodel.table()Returns the table that holds the column to which this metamodel is pointing.Navigable.table()Returns the navigable of the table that holds the column this navigable points to.SqlFunction.Call.table()Navigable.tableType()Returns the type of the table that holds the column this navigable points to.IntegrityViolation.Check.type()Returns the value of thetyperecord component.IntegrityViolation.ForeignKey.type()Returns the value of thetyperecord component.IntegrityViolation.Length.type()Returns the value of thetyperecord component.IntegrityViolation.NotNull.type()Returns the value of thetyperecord component.IntegrityViolation.NumericRange.type()Returns the value of thetyperecord component.IntegrityViolation.Referenced.type()Returns the value of thetyperecord component.IntegrityViolation.type()Returns the entity type of the write that was refused.IntegrityViolation.Unique.type()Returns the value of thetyperecord component.Modifier and TypeMethodDescriptionvoidInvoked when a new record is processed.ModifierConstructorDescriptionCreates an instance of aCheckrecord class.ForeignKey(@Nullable String constraint, @Nullable String table, @Nullable Class<? extends Data> type, List<Metamodel<?, ?>> fields) Creates an instance of aForeignKeyrecord class.Length(@Nullable String table, @Nullable Class<? extends Data> type, List<Metamodel<?, ?>> fields, @Nullable Integer maxLength) Creates an instance of aLengthrecord class.Creates an instance of aNotNullrecord class.NumericRange(@Nullable String table, @Nullable Class<? extends Data> type, List<Metamodel<?, ?>> fields, @Nullable Integer precision, @Nullable Integer scale) Creates an instance of aNumericRangerecord class.Referenced(@Nullable String constraint, @Nullable String table, @Nullable Class<? extends Data> type) Creates an instance of aReferencedrecord class.Unique(@Nullable String constraint, @Nullable String table, @Nullable Class<? extends Data> type, List<Metamodel<?, ?>> fields) Creates an instance of aUniquerecord class. -
Uses of Data in st.orm.mapping
Methods in st.orm.mapping that return types with arguments of type Data -
Uses of Data in st.orm.repository
Methods in st.orm.repository with type parameters of type DataModifier and TypeMethodDescriptiondefault <V extends Data>
longCounts entities matching the specified field and referenced value.default <V extends Data>
longCounts projections matching the specified field and referenced value.default <V extends Data>
booleanChecks if any entity matching the specified field and referenced value exists.default <V extends Data>
booleanChecks if any projection matching the specified field and referenced value exists.Retrieves entities matching a single field and a single referenced value.Retrieves projections matching a single field and a single referenced value.EntityRepository.findAllByRef(Metamodel<E, V> field, Iterable<? extends Ref<V>> values) Retrieves entities matching a single field against multiple referenced values.ProjectionRepository.findAllByRef(Metamodel<P, V> field, Iterable<? extends Ref<V>> values) Retrieves projections matching a single field against multiple referenced values.EntityRepository.findAllRefBy(Metamodel<E, V> field, Ref<V> value) Retrieves refs to entities matching a single field and a single referenced value.ProjectionRepository.findAllRefBy(Metamodel<P, V> field, Ref<V> value) Retrieves refs to projections matching a single field and a single referenced value.EntityRepository.findAllRefByRef(Metamodel<E, V> field, Iterable<? extends Ref<V>> values) Retrieves refs to entities matching a single field against multiple referenced values.ProjectionRepository.findAllRefByRef(Metamodel<P, V> field, Iterable<? extends Ref<V>> values) Retrieves refs to projections matching a single field against multiple referenced values.Retrieves an entity based on a single field and its referenced value.Retrieves a projection based on a single field and its referenced value.EntityRepository.findByRef(Metamodel.Key<E, V> key, Ref<V> value) Retrieves an entity by the ref value of a unique key field that references another entity.ProjectionRepository.findByRef(Metamodel.Key<P, V> key, Ref<V> value) Retrieves a projection by the ref value of a unique key field that references another entity.Retrieves a ref to an entity based on a single field and its referenced value.Retrieves a ref to a projection based on a single field and its referenced value.Retrieves exactly one entity based on a single field and its referenced value.Retrieves exactly one projection based on a single field and its referenced value.EntityRepository.getByRef(Metamodel.Key<E, V> key, Ref<V> value) Retrieves an entity by the ref value of a unique key field that references another entity.ProjectionRepository.getByRef(Metamodel.Key<P, V> key, Ref<V> value) Retrieves a projection by the ref value of a unique key field that references another entity.Retrieves a ref to exactly one entity based on a single field and its referenced value.Retrieves a ref to exactly one projection based on a single field and its referenced value.default <V extends Data>
intEntityRepository.removeAllBy(Metamodel<E, V> field, Ref<V> value) Removes entities matching the specified field and referenced value.default <V extends Data>
intEntityRepository.removeAllByRef(Metamodel<E, V> field, Iterable<? extends Ref<V>> values) Removes entities matching the specified field against multiple referenced values.<R extends Data>
QueryBuilder<E, Ref<R>, ID> Creates a new query builder for selecting refs to entities of the type managed by this repository.<R extends Data>
QueryBuilder<P, Ref<R>, ID> Creates a new query builder for selecting refs to projections of the type managed by this repository. -
Uses of Data in st.orm.spi
Methods in st.orm.spi that return types with arguments of type Data -
Uses of Data in st.orm.template
Classes in st.orm.template with type parameters of type DataModifier and TypeInterfaceDescriptioninterfaceJoinBuilder<T extends Data,R, ID> A builder for specifying the ON condition of a JOIN clause using a custom string template expression.interfaceProvides metadata about an entity or projection type, including its table name, primary key type, and column definitions.interfacePredicateBuilder<T extends Data,R, ID> Represents a composable predicate for the WHERE clause of a query, supportingANDandORcomposition.classQueryBuilder<T extends Data,R, ID> A fluent builder for constructing type-safe SELECT, UPDATE and DELETE queries using the entity graph and metamodel.interfaceTypedJoinBuilder<T extends Data,R, ID> A builder for specifying the ON condition of a JOIN clause using a type-safe entity relation or a custom expression.classWhereBuilder<T extends Data,R, ID> A builder for constructing the WHERE clause of a query, providing type-safe predicate construction.Methods in st.orm.template with type parameters of type DataModifier and TypeMethodDescription<T extends Data>
QueryBuilder<T, ?, ?> QueryTemplate.deleteFrom(Class<T> fromType) Creates a query builder for the specified table to delete from.Query.getRefList(Class<T> type, Class<?> pkType) Execute a SELECT query and return the resulting rows as a list of ref instances.Query.getRefStream(Class<T> type, Class<?> pkType) Execute a SELECT query and return the resulting rows as a stream of ref instances.abstract <V extends Data>
SequencedMap<V, List<R>> QueryBuilder.getResultGroupedBy(TypedMetamodel<T, V, V> path) Executes the query and returns the results grouped by the record reached viapath, typically the parent entity of a foreign key.abstract <V extends Data>
SequencedMap<Ref<V>, List<R>> QueryBuilder.getResultGroupedByRef(Metamodel<T, V> path) Executes the query and returns the results grouped by a lightweight ref to the record reached viapath, typically the parent entity of a foreign key.Get the model for the specified recordtype.Get the model for the specified recordtype.abstract <X extends Data>
QueryBuilder<X, R, ID> Returns a query builder rooted at the specified type, narrowing a builder whose root was relaxed by a join.Creates a ref instance for the specified recordtypeandpk.QueryTemplate.ref(T record, ID id) Creates a ref instance for the specified recordtypeandid.default <T extends Data>
QueryBuilder<T, T, ?> QueryTemplate.selectFrom(Class<T> fromType) Creates a query builder for the specified table.default <T extends Data,R>
QueryBuilder<T, R, ?> QueryTemplate.selectFrom(Class<T> fromType, Class<R> selectType) Creates a query builder for the specified table and select type.<T extends Data,R>
QueryBuilder<T, R, ?> QueryTemplate.selectFrom(Class<T> fromType, Class<R> selectType, StringTemplatePREVIEW template) Creates a query builder for the specified table and select type using the giventemplate.abstract <V extends Data>
QueryBuilder<T, R, ID> Sets a foreign key of the rows an UPDATE query updates to the record the given ref refers to.default <T extends Data>
QueryBuilder<T, ?, ?> Create a subquery for the given table.default <T extends Data,R extends Data>
QueryBuilder<T, ?, ?> Create a subquery for the given table and select type.default <T extends Data,R extends Data>
QueryBuilder<T, ?, ?> Create a subquery for the given table and select type.<T extends Data>
QueryBuilder<T, ?, ?> SubqueryTemplate.subquery(Class<T> fromType, StringTemplatePREVIEW template) Create a subquery for the given table and select type using the giventemplate.<T extends Data>
QueryBuilder<T, ?, ?> QueryTemplate.updateFrom(Class<T> fromType) Creates a query builder for the specified table to update.final <V extends Data>
QueryBuilder<T, R, ID> Adds a WHERE clause that matches the specified records.final <V extends Data>
QueryBuilder<T, R, ID> Adds a WHERE clause that matches the specified ref.final <V extends Data>
QueryBuilder<T, R, ID> Adds a WHERE clause that matches the specified record.final <V extends Data>
PredicateBuilder<T, R, ID> Adds a condition to the WHERE clause that matches the specified records.abstract <V extends Data>
PredicateBuilder<T, R, ID> Adds a condition to the WHERE clause that matches the specified ref.final <V extends Data>
PredicateBuilder<T, R, ID> Adds a condition to the WHERE clause that matches the specified record.final <V extends Data>
QueryBuilder<T, R, ID> Adds a WHERE clause that matches the specified records.abstract <V extends Data>
PredicateBuilder<T, R, ID> Adds a condition to the WHERE clause that matches the specified refs.Methods in st.orm.template that return types with arguments of type DataModifier and TypeMethodDescriptionabstract QueryBuilder<Data, R, ID> Adds a cross join to the query.abstract QueryBuilder<Data, R, ID> QueryBuilder.crossJoin(StringTemplatePREVIEW template) Adds a cross join to the query.Column.metamodel()Gets the metamodel of the column.JoinBuilder.on(StringTemplatePREVIEW template) Specifies the join condition using a custom expression.Specifies the relation to join on.TypedJoinBuilder.on(Class<? extends Data> relation, Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> condition) Specifies the relation to join on, with a condition the join adds to the foreign key it resolves.TypedJoinBuilder.on(Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> predicate) Specifies the relation to join on as a predicate, which states it as a whole: the keys it equates and any condition on the joined rows.abstract QueryBuilder<Data, R, ID> QueryBuilder.widen()Widens the query as a join does, without joining: from here on, every clause accepts paths from any entity in the query.Methods in st.orm.template with parameters of type DataModifier and TypeMethodDescriptionvoidAdd a record to the batch.static ElementGenerates a SET clause for the specified record.static ElementTemplates.set(Data record, Collection<Metamodel<?, ?>> fields) Generates a SET clause for the specified record.static ElementGenerates a VALUES clause for the specified record instance(s).static ElementGenerates a VALUES clause for the specified record instance(s).Method parameters in st.orm.template with type arguments of type DataModifier and TypeMethodDescriptionstatic ElementGenerates an alias element for the specified table class.static ElementTemplates.alias(Class<? extends Data> table, ResolveScope scope) Generates an alias element for the specified table class.abstract TypedJoinBuilder<T, R, ID> Adds an anti-join to the query: the query keeps the rows that have no related row in the given table matching the condition stated on the join, or no related row at all when the join states none.static ElementCreates a new var element that can be used to specify individual bind variables in the query.abstract QueryBuilder<Data, R, ID> Adds a cross join to the query.static ElementGenerates a DELETE element for the specified table class.static ElementGenerates a DELETE element for the specified table class with an alias.abstract QueryBuilder<T, R, ID> Resolves the references at the specified paths as part of this query.final QueryBuilder<T, R, ID> Resolves the references at the specified paths as part of this query.static ElementGenerates a FROM element for the specified table class without an alias and optional auto-joining of foreign keys.static ElementGenerates a FROM element for the specified table class, with an alias and optional auto-joining of foreign keys.abstract TypedJoinBuilder<T, R, ID> Adds an inner join to the query.static ElementGenerates an INSERT element for the specified table class.static ElementGenerates an INSERT element for the specified table class.abstract TypedJoinBuilder<T, R, ID> Adds a join of the specified type to the query.abstract TypedJoinBuilder<T, R, ID> Adds a left join to the query.voidORMTemplate.loadSchema(Predicate<Class<? extends Data>> filter) Loads the database schema of the discovered types matching the filter, without validating them, and keeps it for the data source.Specifies the relation to join on.TypedJoinBuilder.on(Class<? extends Data> relation, Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> condition) Specifies the relation to join on, with a condition the join adds to the foreign key it resolves.TypedJoinBuilder.on(Class<? extends Data> relation, Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> condition) Specifies the relation to join on, with a condition the join adds to the foreign key it resolves.TypedJoinBuilder.on(Class<? extends Data> relation, Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> condition) Specifies the relation to join on, with a condition the join adds to the foreign key it resolves.TypedJoinBuilder.on(Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> predicate) Specifies the relation to join on as a predicate, which states it as a whole: the keys it equates and any condition on the joined rows.TypedJoinBuilder.on(Function<WhereBuilder<Data, R, ID>, PredicateBuilder<Data, ?, ?>> predicate) Specifies the relation to join on as a predicate, which states it as a whole: the keys it equates and any condition on the joined rows.abstract TypedJoinBuilder<T, R, ID> Adds a right join to the query.static ElementGenerates a SELECT element for the specified table class.static ElementTemplates.select(Class<? extends Data> table, SelectMode mode) Generates a SELECT element for the specified table class.abstract TypedJoinBuilder<T, R, ID> Adds a semi-join to the query: the query keeps the rows that have a related row in the given table matching the conditions that name it, and returns each of them once.static ElementGenerates a Table element for the specified table class.static ElementGenerates a Table element with an alias for the specified table class.static ElementGenerates an UPDATE element for the specified table class.static ElementGenerates an UPDATE element for the specified table class with an alias.ORMTemplate.validateSchema(Iterable<Class<? extends Data>> types) Validates the specified types against the database schema.ORMTemplate.validateSchema(Predicate<Class<? extends Data>> filter) Validates discovered types matching the filter against the database schema.voidORMTemplate.validateSchemaOrThrow(Iterable<Class<? extends Data>> types) Validates the specified types and throws if any errors are found.voidORMTemplate.validateSchemaOrThrow(Predicate<Class<? extends Data>> filter) Validates discovered types matching the filter and throws if any errors are found.static ElementGenerates a VALUES clause for the specified iterable of record instances.static ElementGenerates a VALUES clause for the specified iterable of record instances. -
Uses of Data in st.orm.template.impl
Classes in st.orm.template.impl with type parameters of type DataModifier and TypeClassDescriptionclassRepresents the model of an entity.final classQueryBuilderImpl<T extends Data,R, ID> static classQueryBuilderImpl.PredicateBuilderImpl<TX extends Data,RX, IDX> Methods in st.orm.template.impl with type parameters of type DataModifier and TypeMethodDescription<T extends Data>
QueryBuilder<T, ?, ?> QueryTemplateImpl.deleteFrom(Class<T> fromType) QueryImpl.getRefList(Class<T> type, Class<?> pkType) QueryImpl.getRefStream(Class<T> type, Class<?> pkType) Execute a SELECT query and return the resulting rows as a stream of ref instances.<V extends Data>
SequencedMap<V, List<R>> QueryBuilderImpl.getResultGroupedBy(TypedMetamodel<T, V, V> path) <V extends Data>
SequencedMap<Ref<V>, List<R>> QueryBuilderImpl.getResultGroupedByRef(Metamodel<T, V> path) <X extends Data>
QueryBuilder<X, R, ID> Returns a query builder rooted at the specified type.static <TX extends Data,RX, IDX>
PredicateBuilder<TX, RX, IDX> QueryBuilderImpl.PredicateBuilderImpl.of(st.orm.core.template.PredicateBuilder<TX, RX, IDX> core) Returns the predicate builder of the Java API over the given core predicate builder.QueryTemplateImpl.ref(T record, ID id) <T extends Data,R>
QueryBuilder<T, R, Object> QueryTemplateImpl.selectFrom(Class<T> fromType, Class<R> selectType, StringTemplatePREVIEW template) <V extends Data>
QueryBuilder<T, R, ID> <T extends Data>
QueryBuilder<T, ?, ?> <T extends Data,R extends Data>
QueryBuilder<T, ?, ?> <T extends Data,R extends Data>
QueryBuilder<T, ?, ?> <T extends Data>
QueryBuilder<T, ?, ?> QueryTemplateImpl.subquery(Class<T> fromType, StringTemplatePREVIEW template) <T extends Data>
QueryBuilder<T, ?, ?> QueryTemplateImpl.updateFrom(Class<T> fromType) Methods in st.orm.template.impl that return types with arguments of type DataModifier and TypeMethodDescriptionAdds a cross join to the query.QueryBuilderImpl.crossJoin(StringTemplatePREVIEW template) Adds a cross join to the query.ColumnImpl.metamodel()Returns the value of themetamodelrecord component.QueryBuilderImpl.widen()Widens the query as a join does, without joining.Methods in st.orm.template.impl with parameters of type DataMethod parameters in st.orm.template.impl with type arguments of type DataModifier and TypeMethodDescriptionAdds an anti-join to the query.Adds a cross join to the query.QueryBuilder<T, R, ID> Resolves the references at the specified paths as part of this query.Adds an inner join to the query.Adds a join of the specified type to the query.Adds a left join to the query.voidORMTemplateImpl.loadSchema(Predicate<Class<? extends Data>> filter) Adds a right join to the query.Adds a semi-join to the query.ORMTemplateImpl.validateSchema(Iterable<Class<? extends Data>> types) ORMTemplateImpl.validateSchema(Predicate<Class<? extends Data>> filter) voidORMTemplateImpl.validateSchemaOrThrow(Iterable<Class<? extends Data>> types) voidORMTemplateImpl.validateSchemaOrThrow(Predicate<Class<? extends Data>> filter) Constructor parameters in st.orm.template.impl with type arguments of type DataModifierConstructorDescriptionColumnImpl(st.orm.core.template.Column core, int index, String name, Class<?> type, boolean primaryKey, GenerationStrategy generation, String sequence, boolean foreignKey, boolean nullable, boolean insertable, boolean updatable, boolean version, boolean ref, @Nullable String function, Metamodel<Data, ?> metamodel) Creates an instance of aColumnImplrecord class.