Package tech.ydb.yoj.repository.db

Class EntityIdSchema<ID extends Entity.Id<?>>

java.lang.Object

tech.ydb.yoj.databind.schema.Schema<ID>

tech.ydb.yoj.repository.db.EntityIdSchema<ID>

All Implemented Interfaces:

Comparator<ID>

public final class EntityIdSchema<ID extends Entity.Id<?>>
extends Schema<ID>
implements Comparator<ID>

Nested Class Summary

Nested classes/interfaces inherited from class tech.ydb.yoj.databind.schema.Schema

Schema.Changefeed, Schema.Dynamic, Schema.Index, Schema.JavaField, Schema.JavaFieldValue, Schema.TtlModifier

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_FIELD_NAME	Name and also path of Entity's ID field.
static final Comparator<Entity<?>>	SORT_ENTITY_BY_ID

Fields inherited from class tech.ydb.yoj.databind.schema.Schema

PATH_DELIMITER, reflectType

Method Summary

Modifier and Type	Method	Description
int	compare(ID a, ID b)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	from(EntitySchema<T> entitySchema)
static <T extends Entity<T>> Comparator<Entity.Id<T>>	getIdComparator(Class<T> type)
protected boolean	isFlattenable(ReflectField field)
static boolean	isIdField(@NonNull Schema.JavaField field)
static boolean	isIdFieldName(@NonNull String name)
static boolean	isIdFieldPath(@NonNull String path)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	of(Class<ID> idType)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	of(Class<ID> idType, NamingStrategy namingStrategy)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	of(SchemaRegistry registry, Class<ID> idType)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	of(SchemaRegistry registry, Class<ID> idType, NamingStrategy namingStrategy)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	ofEntity(Class<T> entityType)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	ofEntity(Class<T> entityType, NamingStrategy namingStrategy)
static <T extends Entity<T>, ID extends Entity.Id<T>> EntityIdSchema<ID>	ofEntity(SchemaRegistry registry, Class<T> entityType, NamingStrategy namingStrategy)

Methods inherited from class tech.ydb.yoj.databind.schema.Schema

equals, findField, flatten, flattenFieldNames, flattenFields, flattenOneField, flattenToList, getChangefeeds, getField, getFields, getGlobalIndexes, getName, getNamingStrategy, getSchemaKey, getTtlModifier, getType, hashCode, isDynamic, newInstance, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Details

ID_FIELD_NAME

public static final String ID_FIELD_NAME

Name and also path of Entity's ID field. Use this constant if you need to reference ID field in a query, filter or order expression.
If you need to check whether the specified field is a [part of] ID field, use the isIdField(JavaField), isIdFieldPath(String) and isIdFieldName(String) methods instead.

See Also:

• isIdField(JavaField)
• isIdFieldPath(String)
• isIdFieldName(String)
• Constant Field Values

SORT_ENTITY_BY_ID

public static final Comparator<Entity<?>> SORT_ENTITY_BY_ID

Method Details

getIdComparator

public static <T extends Entity<T>>
Comparator<Entity.Id<T>> getIdComparator(Class<T> type)

isFlattenable

protected boolean isFlattenable(ReflectField field)

Overrides:

isFlattenable in class Schema<ID extends Entity.Id<?>>

ofEntity

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> ofEntity(Class<T> entityType)

ofEntity

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> ofEntity(Class<T> entityType,
 NamingStrategy namingStrategy)

Parameters:

namingStrategy - naming strategy with mandatory equals/hashCode.

ofEntity

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> ofEntity(SchemaRegistry registry,
 Class<T> entityType,
 NamingStrategy namingStrategy)

Parameters:

namingStrategy - naming strategy with mandatory equals/hashCode.

of

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> of(Class<ID> idType)

of

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> of(Class<ID> idType,
 NamingStrategy namingStrategy)

Parameters:

namingStrategy - naming strategy with mandatory equals/hashCode.

of

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> of(SchemaRegistry registry,
 Class<ID> idType)

of

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> of(SchemaRegistry registry,
 Class<ID> idType,
 NamingStrategy namingStrategy)

Parameters:

namingStrategy - naming strategy with mandatory equals/hashCode.

from

public static <T extends Entity<T>,
ID extends Entity.Id<T>>
EntityIdSchema<ID> from(EntitySchema<T> entitySchema)

isIdField

public static boolean isIdField(@NonNull
 @NonNull Schema.JavaField field)

isIdFieldPath

public static boolean isIdFieldPath(@NonNull
 @NonNull String path)

isIdFieldName

public static boolean isIdFieldName(@NonNull
 @NonNull String name)

compare

public int compare(@NonNull
 ID a,
 @NonNull
 ID b)

Specified by:

compare in interface Comparator<ID extends Entity.Id<?>>