Uses of Interface
st.orm.Data

Packages that use Data
Package
Description
st.orm
Foundation of the data model: the mapping annotations and the record interfaces.
st.orm.mapping
Record mapping contracts.
st.orm.repository
Java repository API.
st.orm.template
Java client API: templates, query builders and transactions.

  • Uses of Data in st.orm

    Classes in st.orm with type parameters of type Data
    Modifier and Type
    Class
    Description
    class 
    AbstractKeyMetamodel<T extends Data,E,V extends @Nullable Object>
    Extension of AbstractMetamodel that implements Metamodel.Key, indicating that the field has a uniqueness constraint.
    class 
    AbstractMetamodel<T extends Data,E,V extends @Nullable Object>
    Implementation that is used by the generated models.
    class 
    AbstractNavigableMetamodel<T extends Data,E>
    Base implementation for generated navigation-only metamodels — nodes that navigate the entity graph beyond a Ref foreign key.
    interface 
    Metamodel<T extends Data,E>
    The metamodel provides type-safe references to entity fields for use in queries.
    static interface 
    Metamodel.Key<T extends Data,E>
    Marker interface for metamodel fields that correspond to columns known to be unique.
    static final record 
    Metamodel.KeyDelegate<T extends Data,E>
    Delegating wrapper that adds the Metamodel.Key marker to an existing Metamodel instance.
    interface 
    Navigable<T extends Data,E>
    The navigational part of a Metamodel: 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.
    interface 
    Ref<T extends Data>
    Ref records are used to represent reference to records, allowing them to be fetched from the database.
    final record 
    Scrollable<T extends Data>
    Represents a scroll request that captures the cursor state needed to fetch a window of results.
    interface 
    TypedMetamodel<T extends Data,E,V extends @Nullable Object>
    A Metamodel that also carries the declared component type of the field it represents.
    Subinterfaces of Data in st.orm
    Modifier and Type
    Interface
    Description
    interface 
    Entity<ID>
    Optional marker interface for record-based entities.
    interface 
    Projection<ID>
    Marker interface for record-based projections.
    Methods in st.orm with type parameters of type Data
    Modifier and Type
    Method
    Description
    static <T extends Data, E>
    Scrollable<T>
    Scrollable.fromCursor(Metamodel.Key<T,E> key, String cursor)
    Deserializes a cursor string (produced by Scrollable.toCursor()) into a Scrollable for single-key scrolling.
    static <T extends Data, E, S>
    Scrollable<T>
    Scrollable.fromCursor(Metamodel.Key<T,E> key, @Nullable Metamodel<T,S> sort, String cursor)
    Deserializes a cursor string (produced by Scrollable.toCursor()) into a Scrollable for composite scrolling with a sort field.
    static <T extends Data, E>
    Metamodel.Key<T,E>
    Metamodel.key(Metamodel<T,E> metamodel)
    Returns a Key view of the given metamodel.
    <T extends Data>
    @Nullable Scrollable<T>
    Window.next()
    Returns a typed scrollable for fetching the next window, or null if the window is empty.
    static <T extends Data, E>
    Metamodel<T,E>
    Metamodel.of(Class<T> rootTable, String path)
    Creates a new metamodel for the given root rootTable and path.
    static <T extends Data, ID>
    Ref<T>
    Ref.of(Class<T> type, ID pk)
    Creates a detached ref instance for the given type and primary key.
    static <T extends Data, E>
    Scrollable<T>
    Scrollable.of(Metamodel.Key<T,E> key, int size)
    Creates a scrollable request for the first page in ascending key order.
    static <T extends Data, E>
    Scrollable<T>
    Scrollable.of(Metamodel.Key<T,E> key, E keyCursor, int size)
    Creates a scrollable request starting after the given cursor value, in ascending key order.
    static <T extends Data, E, S>
    Scrollable<T>
    Scrollable.of(Metamodel.Key<T,E> key, E keyCursor, Metamodel<T,S> sort, S sortCursor, int size)
    Creates a scrollable request starting after the given cursor values, in ascending key order, sorted by the given field.
    static <T extends Data, E, S>
    Scrollable<T>
    Scrollable.of(Metamodel.Key<T,E> key, Metamodel<T,S> sort, int size)
    Creates a scrollable request for the first page in ascending key order, sorted by the given field.
    <T extends Data>
    @Nullable Scrollable<T>
    Window.previous()
    Returns a typed scrollable for fetching the previous window, or null if the window is empty.
    static <T extends Data>
    Metamodel<T,T>
    Metamodel.root(Class<T> table)
    Creates a new metamodel for the given record type.
    Methods in st.orm that return types with arguments of type Data
    Modifier and Type
    Method
    Description
    default Metamodel<? extends Data,E>
    Navigable.canonical()
    Returns the canonical metamodel for the field represented by this.
    Metamodel<T,? extends Data>
    AbstractMetamodel.table()
    Returns the table that holds the column to which this metamodel is pointing.
    Navigable<T,? extends Data>
    AbstractNavigableMetamodel.table()
     
    Metamodel<T,? extends Data>
    Metamodel.KeyDelegate.table()
     
    Metamodel<T,? extends Data>
    Metamodel.table()
    Returns the table that holds the column to which this metamodel is pointing.
    Navigable<T,? extends Data>
    Navigable.table()
    Returns the navigable of the table that holds the column this navigable points to.
    default Class<? extends Data>
    Navigable.tableType()
    Returns the type of the table that holds the column this navigable points to.
    Methods in st.orm with parameters of type Data
    Modifier and Type
    Method
    Description
    void
    BindVars.RecordListener.onRecord(Data record)
    Invoked when a new record is processed.

  • Uses of Data in st.orm.mapping

    Methods in st.orm.mapping that return types with arguments of type Data
    Modifier and Type
    Method
    Description
    Class<? extends Data>
    RecordField.requireDataType()
    Returns the field type as a Data subtype, or throws an exception if the type does not implement Data.
    Class<? extends Data>
    RecordType.requireDataType()
    Returns this record type as a Data subtype, or throws an exception if the type does not implement Data.

  • Uses of Data in st.orm.repository

    Methods in st.orm.repository with type parameters of type Data
    Modifier and Type
    Method
    Description
    default <V extends Data>
    long
    EntityRepository.countBy(Metamodel<E,V> field, Ref<V> value)
    Counts entities matching the specified field and referenced value.
    default <V extends Data>
    long
    ProjectionRepository.countBy(Metamodel<P,V> field, Ref<V> value)
    Counts projections matching the specified field and referenced value.
    default <V extends Data>
    boolean
    EntityRepository.existsBy(Metamodel<E,V> field, Ref<V> value)
    Checks if any entity matching the specified field and referenced value exists.
    default <V extends Data>
    boolean
    ProjectionRepository.existsBy(Metamodel<P,V> field, Ref<V> value)
    Checks if any projection matching the specified field and referenced value exists.
    default <V extends Data>
    List<E>
    EntityRepository.findAllBy(Metamodel<E,V> field, Ref<V> value)
    Retrieves entities matching a single field and a single referenced value.
    default <V extends Data>
    List<P>
    ProjectionRepository.findAllBy(Metamodel<P,V> field, Ref<V> value)
    Retrieves projections matching a single field and a single referenced value.
    default <V extends Data>
    List<E>
    EntityRepository.findAllByRef(Metamodel<E,V> field, Iterable<? extends Ref<V>> values)
    Retrieves entities matching a single field against multiple referenced values.
    default <V extends Data>
    List<P>
    ProjectionRepository.findAllByRef(Metamodel<P,V> field, Iterable<? extends Ref<V>> values)
    Retrieves projections matching a single field against multiple referenced values.
    default <V extends Data>
    List<Ref<E>>
    EntityRepository.findAllRefBy(Metamodel<E,V> field, Ref<V> value)
    Retrieves refs to entities matching a single field and a single referenced value.
    default <V extends Data>
    List<Ref<P>>
    ProjectionRepository.findAllRefBy(Metamodel<P,V> field, Ref<V> value)
    Retrieves refs to projections matching a single field and a single referenced value.
    default <V extends Data>
    List<Ref<E>>
    EntityRepository.findAllRefByRef(Metamodel<E,V> field, Iterable<? extends Ref<V>> values)
    Retrieves refs to entities matching a single field against multiple referenced values.
    default <V extends Data>
    List<Ref<P>>
    ProjectionRepository.findAllRefByRef(Metamodel<P,V> field, Iterable<? extends Ref<V>> values)
    Retrieves refs to projections matching a single field against multiple referenced values.
    default <V extends Data>
    Optional<E>
    EntityRepository.findBy(Metamodel<E,V> field, Ref<V> value)
    Retrieves an entity based on a single field and its referenced value.
    default <V extends Data>
    Optional<P>
    ProjectionRepository.findBy(Metamodel<P,V> field, Ref<V> value)
    Retrieves a projection based on a single field and its referenced value.
    <V extends Data>
    Optional<E>
    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.
    <V extends Data>
    Optional<P>
    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.
    default <V extends Data>
    Optional<Ref<E>>
    EntityRepository.findRefBy(Metamodel<E,V> field, Ref<V> value)
    Retrieves a ref to an entity based on a single field and its referenced value.
    default <V extends Data>
    Optional<Ref<P>>
    ProjectionRepository.findRefBy(Metamodel<P,V> field, Ref<V> value)
    Retrieves a ref to a projection based on a single field and its referenced value.
    default <V extends Data>
    E
    EntityRepository.getBy(Metamodel<E,V> field, Ref<V> value)
    Retrieves exactly one entity based on a single field and its referenced value.
    default <V extends Data>
    P
    ProjectionRepository.getBy(Metamodel<P,V> field, Ref<V> value)
    Retrieves exactly one projection based on a single field and its referenced value.
    <V extends Data>
    E
    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.
    <V extends Data>
    P
    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.
    default <V extends Data>
    Ref<E>
    EntityRepository.getRefBy(Metamodel<E,V> field, Ref<V> value)
    Retrieves a ref to exactly one entity based on a single field and its referenced value.
    default <V extends Data>
    Ref<P>
    ProjectionRepository.getRefBy(Metamodel<P,V> field, Ref<V> value)
    Retrieves a ref to exactly one projection based on a single field and its referenced value.
    default <V extends Data>
    int
    EntityRepository.removeAllBy(Metamodel<E,V> field, Ref<V> value)
    Removes entities matching the specified field and referenced value.
    default <V extends Data>
    int
    EntityRepository.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>
    EntityRepository.selectRef(Class<R> refType)
    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>
    ProjectionRepository.selectRef(Class<R> refType)
    Creates a new query builder for selecting refs to projections of the type managed by this repository.

  • Uses of Data in st.orm.template

    Classes in st.orm.template with type parameters of type Data
    Modifier and Type
    Interface
    Description
    interface 
    JoinBuilder<T extends Data,R,ID>
    A builder for specifying the ON condition of a JOIN clause using a custom string template expression.
    interface 
    Model<E extends Data,ID>
    Provides metadata about an entity or projection type, including its table name, primary key type, and column definitions.
    interface 
    PredicateBuilder<T extends Data,R,ID>
    Represents a composable predicate for the WHERE clause of a query, supporting AND and OR composition.
    class 
    QueryBuilder<T extends Data,R,ID>
    A fluent builder for constructing type-safe SELECT and DELETE queries using the entity graph and metamodel.
    interface 
    TypedJoinBuilder<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.
    class 
    WhereBuilder<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 Data
    Modifier and Type
    Method
    Description
    <T extends Data>
    QueryBuilder<T,?,?>
    QueryTemplate.deleteFrom(Class<T> fromType)
    Creates a query builder for the specified table to delete from.
    default <T extends Data>
    List<Ref<T>>
    Query.getRefList(Class<T> type, Class<?> pkType)
    Execute a SELECT query and return the resulting rows as a list of ref instances.
    <T extends Data>
    Stream<Ref<T>>
    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 via path, 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 via path, typically the parent entity of a foreign key.
    default <T extends Data, ID>
    Model<T,ID>
    QueryTemplate.model(Class<T> type)
    Get the model for the specified record type.
    <T extends Data, ID>
    Model<T,ID>
    QueryTemplate.model(Class<T> type, boolean requirePrimaryKey)
    Get the model for the specified record type.
    abstract <X extends Data>
    QueryBuilder<X,R,ID>
    QueryBuilder.narrow(Class<X> rootType)
    Returns a query builder rooted at the specified type, narrowing a builder whose root was relaxed by a join.
    <T extends Data, ID>
    Ref<T>
    QueryTemplate.ref(Class<T> type, ID id)
    Creates a ref instance for the specified record type and pk.
    <T extends Data, ID>
    Ref<T>
    QueryTemplate.ref(T record, ID id)
    Creates a ref instance for the specified record type and id.
    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 given template.
    default <T extends Data>
    QueryBuilder<T,?,?>
    SubqueryTemplate.subquery(Class<T> fromType)
    Create a subquery for the given table.
    default <T extends Data, R extends Data>
    QueryBuilder<T,?,?>
    SubqueryTemplate.subquery(Class<T> fromType, Class<R> selectType)
    Create a subquery for the given table and select type.
    default <T extends Data, R extends Data>
    QueryBuilder<T,?,?>
    SubqueryTemplate.subquery(Class<T> fromType, Class<R> selectType)
    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 given template.
    final <V extends Data>
    QueryBuilder<T,R,ID>
    QueryBuilder.where(Navigable<? extends T,V> path, Iterable<V> it)
    Adds a WHERE clause that matches the specified records.
    final <V extends Data>
    QueryBuilder<T,R,ID>
    QueryBuilder.where(Navigable<? extends T,V> path, Ref<V> ref)
    Adds a WHERE clause that matches the specified ref.
    final <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.where(Navigable<? extends T,V> path, Iterable<V> it)
    Adds a condition to the WHERE clause that matches the specified records.
    abstract <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.where(Navigable<? extends T,V> path, Ref<V> ref)
    Adds a condition to the WHERE clause that matches the specified ref.
    final <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.where(Navigable<? extends T,V> path, V record)
    Adds a condition to the WHERE clause that matches the specified record.
    final <V extends Data>
    QueryBuilder<T,R,ID>
    QueryBuilder.whereRef(Navigable<? extends T,V> path, Iterable<? extends Ref<V>> it)
    Adds a WHERE clause that matches the specified records.
    abstract <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.whereRef(Navigable<? extends T,V> path, Iterable<? extends Ref<V>> it)
    Adds a condition to the WHERE clause that matches the specified refs.
    Methods in st.orm.template that return types with arguments of type Data
    Modifier and Type
    Method
    Description
    abstract QueryBuilder<Data,R,ID>
    QueryBuilder.crossJoin(Class<? extends Data> relation)
    Adds a cross join to the query.
    abstract QueryBuilder<Data,R,ID>
    QueryBuilder.crossJoin(StringTemplatePREVIEW template)
    Adds a cross join to the query.
    Metamodel<Data,?>
    Column.metamodel()
    Gets the metamodel of the column.
    QueryBuilder<Data,R,ID>
    JoinBuilder.on(StringTemplatePREVIEW template)
    Specifies the join condition using a custom expression.
    QueryBuilder<Data,R,ID>
    TypedJoinBuilder.on(Class<? extends Data> relation)
    Specifies the relation to join on.
    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 Data
    Modifier and Type
    Method
    Description
    void
    PreparedQuery.addBatch(Data record)
    Add a record to the batch.
    static Element
    Templates.set(Data record)
    Generates a SET clause for the specified record.
    static Element
    Templates.set(Data record, Collection<Metamodel<?,?>> fields)
    Generates a SET clause for the specified record.
    static Element
    Templates.values(Data... r)
    Generates a VALUES clause for the specified record instance(s).
    static Element
    Templates.values(Data r, boolean ignoreAutoGenerate)
    Generates a VALUES clause for the specified record instance(s).
    Method parameters in st.orm.template with type arguments of type Data
    Modifier and Type
    Method
    Description
    static Element
    Templates.alias(Class<? extends Data> table)
    Generates an alias element for the specified table class.
    static Element
    Templates.alias(Class<? extends Data> table, ResolveScope scope)
    Generates an alias element for the specified table class.
    static Element
    Templates.bindVar(BindVars bindVars, Function<Data,?> extractor)
    Creates a new var element that can be used to specify individual bind variables in the query.
    abstract QueryBuilder<Data,R,ID>
    QueryBuilder.crossJoin(Class<? extends Data> relation)
    Adds a cross join to the query.
    static Element
    Templates.delete(Class<? extends Data> table)
    Generates a DELETE element for the specified table class.
    static Element
    Templates.delete(Class<? extends Data> table, String alias)
    Generates a DELETE element for the specified table class with an alias.
    abstract QueryBuilder<T,R,ID>
    QueryBuilder.fetch(List<? extends Navigable<T,? extends Data>> paths)
    Resolves the references at the specified paths as part of this query.
    static Element
    Templates.from(Class<? extends Data> table, boolean autoJoin)
    Generates a FROM element for the specified table class without an alias and optional auto-joining of foreign keys.
    static Element
    Templates.from(Class<? extends Data> table, String alias, boolean autoJoin)
    Generates a FROM element for the specified table class, with an alias and optional auto-joining of foreign keys.
    abstract TypedJoinBuilder<T,R,ID>
    QueryBuilder.innerJoin(Class<? extends Data> relation)
    Adds an inner join to the query.
    static Element
    Templates.insert(Class<? extends Data> table)
    Generates an INSERT element for the specified table class.
    static Element
    Templates.insert(Class<? extends Data> table, boolean ignoreAutoGenerate)
    Generates an INSERT element for the specified table class.
    abstract TypedJoinBuilder<T,R,ID>
    QueryBuilder.join(JoinType type, Class<? extends Data> relation, String alias)
    Adds a join of the specified type to the query.
    abstract TypedJoinBuilder<T,R,ID>
    QueryBuilder.leftJoin(Class<? extends Data> relation)
    Adds a left join to the query.
    QueryBuilder<Data,R,ID>
    TypedJoinBuilder.on(Class<? extends Data> relation)
    Specifies the relation to join on.
    abstract TypedJoinBuilder<T,R,ID>
    QueryBuilder.rightJoin(Class<? extends Data> relation)
    Adds a right join to the query.
    static Element
    Templates.select(Class<? extends Data> table)
    Generates a SELECT element for the specified table class.
    static Element
    Templates.select(Class<? extends Data> table, SelectMode mode)
    Generates a SELECT element for the specified table class.
    static Element
    Templates.table(Class<? extends Data> table)
    Generates a Table element for the specified table class.
    static Element
    Templates.table(Class<? extends Data> table, String alias)
    Generates a Table element with an alias for the specified table class.
    static Element
    Templates.update(Class<? extends Data> table)
    Generates an UPDATE element for the specified table class.
    static Element
    Templates.update(Class<? extends Data> table, String alias)
    Generates an UPDATE element for the specified table class with an alias.
    List<String>
    ORMTemplate.validateSchema(Iterable<Class<? extends Data>> types)
    Validates the specified types against the database schema.
    List<String>
    ORMTemplate.validateSchema(Predicate<Class<? extends Data>> filter)
    Validates discovered types matching the filter against the database schema.
    void
    ORMTemplate.validateSchemaOrThrow(Iterable<Class<? extends Data>> types)
    Validates the specified types and throws if any errors are found.
    void
    ORMTemplate.validateSchemaOrThrow(Predicate<Class<? extends Data>> filter)
    Validates discovered types matching the filter and throws if any errors are found.
    static Element
    Templates.values(Iterable<? extends Data> records)
    Generates a VALUES clause for the specified iterable of record instances.
    static Element
    Templates.values(Iterable<? extends Data> records, boolean ignoreAutoGenerate)
    Generates a VALUES clause for the specified iterable of record instances.