Uses of Interface
st.orm.Ref

Packages that use Ref
Package
Description
st.orm
 
st.orm.repository
 
st.orm.template
 

  • Uses of Ref in st.orm

    Methods in st.orm that return Ref
    Modifier and Type
    Method
    Description
    static <E extends Entity<?>>
    Ref<E>
    Ref.of(E entity)
    Creates a fully loaded ref instance that wraps the given entity.
    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 <P extends Projection<ID>, ID>
    Ref<P>
    Ref.of(P projection, ID id)
    Creates a fully loaded ref instance that wraps the given projection along with its primary key.
    Ref<T>
    Ref.unload()
    Returns a detached ref with the same identity but without data.
    Methods in st.orm with parameters of type Ref
    Modifier and Type
    Method
    Description
    static <ID, E extends Entity<ID>>
    ID
    Ref.entityId(Ref<E> ref)
    Extracts the primary key from the given entity ref returning a type-safe id.
    static <ID, P extends Projection<ID>>
    ID
    Ref.projectionId(Ref<P> ref)
    Extracts the primary key from the given projection ref returning a type-safe id.

  • Uses of Ref in st.orm.repository

    Methods in st.orm.repository that return Ref
    Modifier and Type
    Method
    Description
    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> Ref<E>
    EntityRepository.getRefBy(Metamodel<E,V> field, V value)
    Retrieves a ref to exactly one entity based on a single field and its 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> Ref<P>
    ProjectionRepository.getRefBy(Metamodel<P,V> field, V value)
    Retrieves a ref to exactly one projection based on a single field and its value.
    Ref<E>
    EntityRepository.ref(E entity)
    Creates a new ref entity instance for the specified entity.
    Ref<E>
    EntityRepository.ref(ID id)
    Creates a new ref entity instance with the specified primary key.
    Ref<P>
    ProjectionRepository.ref(ID id)
    Creates a new ref projection instance with the specified primary key.
    Ref<P>
    ProjectionRepository.ref(P projection, ID id)
    Creates a new ref projection instance with the specified projection.
    Ref<E>
    EntityRepository.unload(E entity)
    Unloads the given entity from memory by converting it into a lightweight ref containing only its primary key.
    Methods in st.orm.repository that return types with arguments of type Ref
    Modifier and Type
    Method
    Description
    List<Ref<E>>
    EntityRepository.findAllRef()
    Returns a list of refs to all entities of the type supported by this repository.
    List<Ref<P>>
    ProjectionRepository.findAllRef()
    Returns a list of refs to all projections of the type supported by this repository.
    default <V> List<Ref<E>>
    EntityRepository.findAllRefBy(Metamodel<E,V> field, Iterable<? extends V> values)
    Retrieves refs to entities matching a single field against multiple 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> List<Ref<E>>
    EntityRepository.findAllRefBy(Metamodel<E,V> field, V value)
    Retrieves refs to entities matching a single field and a single value.
    default <V> List<Ref<P>>
    ProjectionRepository.findAllRefBy(Metamodel<P,V> field, Iterable<? extends V> values)
    Retrieves refs to projections matching a single field against multiple values.
    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> List<Ref<P>>
    ProjectionRepository.findAllRefBy(Metamodel<P,V> field, V value)
    Retrieves refs to projections matching a single field and a single 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<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> Optional<Ref<E>>
    EntityRepository.findRefBy(Metamodel<E,V> field, V value)
    Retrieves a ref to an entity based on a single field and its 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> Optional<Ref<P>>
    ProjectionRepository.findRefBy(Metamodel<P,V> field, V value)
    Retrieves a ref to a projection based on a single field and its value.
    Page<Ref<E>>
    EntityRepository.pageRef(int pageNumber, int pageSize)
    Returns a page of entity refs using offset-based pagination.
    Page<Ref<E>>
    EntityRepository.pageRef(Pageable pageable)
    Returns a page of entity refs using offset-based pagination.
    Page<Ref<P>>
    ProjectionRepository.pageRef(int pageNumber, int pageSize)
    Returns a page of projection refs using offset-based pagination.
    Page<Ref<P>>
    ProjectionRepository.pageRef(Pageable pageable)
    Returns a page of projection refs using offset-based pagination.
    QueryBuilder<E,Ref<E>,ID>
    EntityRepository.selectRef()
    Creates a new query builder for selecting refs to entities of the type managed by this repository.
    <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.
    QueryBuilder<P,Ref<P>,ID>
    ProjectionRepository.selectRef()
    Creates a new query builder for selecting refs to projections 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.
    Methods in st.orm.repository with parameters of type Ref
    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.
    boolean
    EntityRepository.existsByRef(Ref<E> ref)
    Checks if an entity with the specified primary key exists in the database.
    boolean
    ProjectionRepository.existsByRef(Ref<P> ref)
    Checks if a projection with the specified primary key exists in the database.
    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<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>
    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.
    Optional<E>
    EntityRepository.findByRef(Ref<E> ref)
    Retrieves an entity based on its primary key, expressed by a ref.
    <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.
    Optional<P>
    ProjectionRepository.findByRef(Ref<P> ref)
    Retrieves a projection based on its primary key.
    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.
    E
    EntityRepository.getByRef(Ref<E> ref)
    Retrieves an entity based on its primary key, expressed by a ref.
    <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.
    P
    ProjectionRepository.getByRef(Ref<P> ref)
    Retrieves a projection based on its primary key.
    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.
    void
    EntityRepository.removeByRef(Ref<E> ref)
    Removes an entity from the database by its reference.
    Method parameters in st.orm.repository with type arguments of type Ref
    Modifier and Type
    Method
    Description
    long
    EntityRepository.countByRef(Stream<Ref<E>> refs)
    Counts the number of entities identified by the provided stream of refs using the default batch size.
    long
    EntityRepository.countByRef(Stream<Ref<E>> refs, int chunkSize)
    Counts the number of entities identified by the provided stream of refs, with the counting process divided into batches of the specified size.
    long
    ProjectionRepository.countByRef(Stream<Ref<P>> refs)
    Counts the number of projections identified by the provided stream of refs using the default batch size.
    long
    ProjectionRepository.countByRef(Stream<Ref<P>> refs, int chunkSize)
    Counts the number of projections identified by the provided stream of refs, with the counting process divided into batches of the specified size.
    List<E>
    EntityRepository.findAllByRef(Iterable<Ref<E>> refs)
    Retrieves a list of entities based on their primary keys.
    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.
    List<P>
    ProjectionRepository.findAllByRef(Iterable<Ref<P>> refs)
    Retrieves a list of projections based on their primary keys.
    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.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>
    int
    EntityRepository.removeAllByRef(Metamodel<E,V> field, Iterable<? extends Ref<V>> values)
    Removes entities matching the specified field against multiple referenced values.
    void
    EntityRepository.removeByRef(Iterable<Ref<E>> refs)
    Removes a collection of entities from the database in batches.
    void
    EntityRepository.removeByRef(Stream<Ref<E>> refs)
    Removes a stream of entities from the database in batches.
    void
    EntityRepository.removeByRef(Stream<Ref<E>> refs, int batchSize)
    Removes a stream of entities from the database in configurable batch sizes.
    Stream<P>
    ProjectionRepository.selectByRef(Stream<Ref<P>> refs)
    Retrieves a stream of projections based on their primary keys.
    Stream<P>
    ProjectionRepository.selectByRef(Stream<Ref<P>> refs, int chunkSize)
    Retrieves a stream of projections based on their primary keys.

  • Uses of Ref in st.orm.template

    Methods in st.orm.template that return Ref
    Modifier and Type
    Method
    Description
    <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.
    Methods in st.orm.template that return types with arguments of type Ref
    Modifier and Type
    Method
    Description
    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.
    Methods in st.orm.template with parameters of type Ref
    Modifier and Type
    Method
    Description
    final <V extends Data>
    QueryBuilder<T,R,ID>
    QueryBuilder.where(Metamodel<T,V> path, Ref<V> ref)
    Adds a WHERE clause that matches the specified ref.
    final QueryBuilder<T,R,ID>
    QueryBuilder.where(Ref<T> ref)
    Adds a WHERE clause that matches the specified primary key of the table, expressed by a ref.
    abstract <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.where(Metamodel<T,V> path, Ref<V> ref)
    Adds a condition to the WHERE clause that matches the specified ref.
    abstract <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.whereAny(Metamodel<?,V> path, Ref<V> ref)
    Adds a condition to the WHERE clause that matches the specified ref.
    abstract PredicateBuilder<T,R,ID>
    WhereBuilder.whereAnyRef(Ref<?> ref)
    Adds a condition to the WHERE clause that matches the specified primary key of the table, expressed by a ref.
    abstract PredicateBuilder<T,R,ID>
    WhereBuilder.whereRef(Ref<T> ref)
    Adds a condition to the WHERE clause that matches the specified primary key of the table, expressed by a ref.
    Method parameters in st.orm.template with type arguments of type Ref
    Modifier and Type
    Method
    Description
    abstract PredicateBuilder<T,R,ID>
    WhereBuilder.whereAnyRef(Iterable<? extends Ref<?>> it)
    Adds a condition to the WHERE clause that matches the specified primary keys of the table, expressed by a ref.
    abstract <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.whereAnyRef(Metamodel<?,V> path, Iterable<? extends Ref<V>> it)
    Adds a condition to the WHERE clause that matches the specified refs.
    final QueryBuilder<T,R,ID>
    QueryBuilder.whereRef(Iterable<? extends Ref<T>> it)
    Adds a WHERE clause that matches the specified primary keys of the table, expressed by a ref.
    final <V extends Data>
    QueryBuilder<T,R,ID>
    QueryBuilder.whereRef(Metamodel<T,V> path, Iterable<? extends Ref<V>> it)
    Adds a WHERE clause that matches the specified records.
    abstract PredicateBuilder<T,R,ID>
    WhereBuilder.whereRef(Iterable<? extends Ref<T>> it)
    Adds a condition to the WHERE clause that matches the specified primary keys of the table, expressed by a ref.
    abstract <V extends Data>
    PredicateBuilder<T,R,ID>
    WhereBuilder.whereRef(Metamodel<T,V> path, Iterable<? extends Ref<V>> it)
    Adds a condition to the WHERE clause that matches the specified refs.