ru.yandex.clickhouse.jdbcbridge.core

Class BaseRepository<T extends ManagedEntity>

java.lang.Object

ru.yandex.clickhouse.jdbcbridge.core.BaseRepository<T>

All Implemented Interfaces:

Repository<T>

Direct Known Subclasses:

JsonFileRepository

public abstract class BaseRepository<T extends ManagedEntity>
extends Object
implements Repository<T>

Base class for implementing a repository managing entities by ID and optionally (registered) entity type.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Extension<T>	defaultExtension
protected Map<String,T>	mappings
protected Map<String,Extension<T>>	types

Constructor Summary

Constructors

Constructor and Description
BaseRepository(Class<T> clazz)

Method Summary

Modifier and Type	Method and Description
boolean	accept(Class<?> clazz) Check if the given type of entity can be managed by this repository.
protected void	atomicAdd(T entity) Atomic add operation.
protected void	atomicRemove(T entity) Atomic remove operation.
protected T	createFromConfig(String id, io.vertx.core.json.JsonObject config) Create entity based on type defined given configuration.
protected T	createFromType(String id, String type) Create entity of given type.
T	get(String id) Get entity from repository by id.
Class<T>	getEntityClass() Get class of managed entities.
protected String	getEntityName()
protected Extension<T>	getExtensionByType(String type, boolean autoCreate)
List<UsageStats>	getUsageStats() Get usage statistics of the repository.
void	put(String id, T entity) Put a named entity into the repository.
void	registerType(String type, Extension<T> extension) Register new type of entity to be manged in this repository.
protected void	remove(String id) Remove an entity and all its aliases(when id is not an alias) based on given id.
String	resolve(String name) Resolve given name.
protected void	update(String id, io.vertx.core.json.JsonObject config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ru.yandex.clickhouse.jdbcbridge.core.Repository

getOrCreate

Field Detail

types

protected final Map<String,Extension<T extends ManagedEntity>> types

mappings

protected final Map<String,T extends ManagedEntity> mappings

defaultExtension

protected final Extension<T extends ManagedEntity> defaultExtension

Constructor Detail

BaseRepository

public BaseRepository(Class<T> clazz)

Method Detail

getEntityName

protected String getEntityName()

getExtensionByType

protected Extension<T> getExtensionByType(String type,
                                          boolean autoCreate)

createFromType

protected T createFromType(String id,
                           String type)

Create entity of given type.

Parameters:

id - id of the entity

type - type of the entity

Returns:

non-null entity

createFromConfig

protected T createFromConfig(String id,
                             io.vertx.core.json.JsonObject config)

Create entity based on type defined given configuration.

Parameters:

id - id of the entity

config - configuration in JSON format

Returns:

non-null entity

atomicAdd

protected void atomicAdd(T entity)

Atomic add operation. For example, save the entity into a database table.

Parameters:

entity - entity

atomicRemove

protected void atomicRemove(T entity)

Atomic remove operation. For example, delete the entity from a database table.

Parameters:

entity - entity

remove

protected void remove(String id)

Remove an entity and all its aliases(when id is not an alias) based on given id.

Parameters:

id - id of the entity, could be an alias

update

protected void update(String id,
                      io.vertx.core.json.JsonObject config)

getEntityClass

public Class<T> getEntityClass()

Description copied from interface: Repository

Get class of managed entities.

Specified by:

getEntityClass in interface Repository<T extends ManagedEntity>

Returns:

class of managed entities

accept

public boolean accept(Class<?> clazz)

Description copied from interface: Repository

Check if the given type of entity can be managed by this repository.

Specified by:

accept in interface Repository<T extends ManagedEntity>

Parameters:

clazz - class of the entity

Returns:

true if the type of entity can be managed by this repository; false otherwise

resolve

public String resolve(String name)

Description copied from interface: Repository

Resolve given name. Usually just about DNS SRV record resolving, for example: jdbc:clickhouse:{{ ch-server.somedomain }}/system will be resolved to something like jdbc:clickhouse:127.0.0.1:8123/system.

Specified by:

resolve in interface Repository<T extends ManagedEntity>

Parameters:

name - name to resolve

Returns:

resolved name

getUsageStats

public List<UsageStats> getUsageStats()

Description copied from interface: Repository

Get usage statistics of the repository.

Specified by:

getUsageStats in interface Repository<T extends ManagedEntity>

Returns:

usage statistics

registerType

public void registerType(String type,
                         Extension<T> extension)

Description copied from interface: Repository

Register new type of entity to be manged in this repository.

Specified by:

registerType in interface Repository<T extends ManagedEntity>

Parameters:

type - type of entity, defaults to extension class name

extension - extension for instantiate new type of entity

put

public void put(String id,
                T entity)

Description copied from interface: Repository

Put a named entity into the repository.

Specified by:

put in interface Repository<T extends ManagedEntity>

Parameters:

id - id of the entity, could be null

entity - non-null entity to be added

get

public T get(String id)

Description copied from interface: Repository

Get entity from repository by id.

Specified by:

get in interface Repository<T extends ManagedEntity>

Parameters:

id - id of the entity

Returns:

desired entity