Package overit.geocall.edm.registry

Class EDMRegistry

java.lang.Object

overit.geocall.edm.registry.EDMRegistry

@Service
public class EDMRegistry
extends Object

Service responsible for managing the registry of EDM (Extensible Data Model) entities.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENDED_COLUMN_SUFFIX

Constructor Summary

Constructors

Constructor	Description
EDMRegistry(DataEntityFactory dataEntityFactory, EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
void	clearEntities(@NotNull Company company)	Clears all entities associated with a company.
List<DataAttribute>	getAllDataAttributes(@NotNull Class<? extends Entity>[] entityClasses, @NotNull Company company)	Returns a List<DataAttribute> configured for the DataEntitys associated to the provided entityClasses and company.
List<DataAttribute>	getAllDataAttributes(@NotNull String extendedColumn, @NotNull Company company)	Returns a List<DataAttribute> configured for the DataEntitys associated to the provided extendedColumn and company.
List<DataAttribute>	getAllDataAttributes(@NotNull List<Entity> entities, @NotNull Company company)	Returns a List<DataAttribute> configured for the DataEntitys associated to the provided entities and company.
List<DataAttribute>	getAllDataAttributes(@NotNull Attribute extendedAttribute, @NotNull Company company)	Returns a List<DataAttribute> configured for the DataEntitys associated to the provided extendedAttribute and company.
List<DataAttribute>	getAllDataAttributesByAttributeName(@NotNull Class<? extends Entity>[] entityClasses, @NotNull String attributeName, @NotNull Company company)	Returns a List<DataAttribute> configured for the DataEntitys associated to the provided entityClasses, attributeName and company.
List<DataEntity>	getDataEntities(@NotNull Class<? extends Entity>[] entities, @NotNull Company company)	Retrieves a List<DataEntity> by entities and company.
List<DataEntity>	getDataEntitiesByTables(@NotNull Set<String> tables, @NotNull Company company)	Retrieves all DataEntity instances associated with the provided tables and Company.
DataEntity	getDataEntityByName(@NotNull String name, @NotNull Company company)	Retrieves a DataEntity by name and company.
List<Entity>	getEntities(@NotNull Class<? extends Entity>[] entityClasses, @NotNull Company company)	Returns a List<Entity> associated to the provided entityClasses and Company.
boolean	isExtendedAttribute(@NotNull String extendedAttribute, @NotNull List<DataAttribute> dataAttributes, @NotNull Company company)	Returns true in case the provided extendedAttribute was recognized as an EDM extended attribute; false otherwise.
boolean	isExtendedColumn(@NotNull String column, @NotNull Company company)	Returns true in case the column identified by the provided column is extended for the provided Company; false otherwise.
boolean	isExtendedColumn(@NotNull String column, @NotNull Company company, List<Entity> entities)	Returns true in case the column identified by the provided column is extended for the provided Company and list of Entitys; false otherwise.
void	register(@NotNull Entity entity)	Registers a Entity.

Methods inherited from class java.lang.Object

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

Field Details

EXTENDED_COLUMN_SUFFIX

public static final String EXTENDED_COLUMN_SUFFIX

See Also:

• Constant Field Values

Constructor Details

EDMRegistry

@Autowired
public EDMRegistry(DataEntityFactory dataEntityFactory,
 EventPublisher eventPublisher)

Method Details

getDataEntityByName

public DataEntity getDataEntityByName(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull Company company)

Retrieves a DataEntity by name and company.

Parameters:

name - The name of the DataEntity to retrieve.

company - The company associated with the DataEntity.

Returns:

the DataEntity with the specified name for the given company

Throws:

NullPointerException - if name or company is null

getDataEntities

public List<DataEntity> getDataEntities(@NotNull
 @NotNull Class<? extends Entity>[] entities,
 @NotNull
 @NotNull Company company)

Retrieves a List<DataEntity> by entities and company.

Parameters:

entities - the models array of the DataEntity to retrieve.

company - the company associated with the DataEntitys to return.

Returns:

the List<DataEntity> by entities and company.

Throws:

NullPointerException - if entities or company are null.

getEntities

public List<Entity> getEntities(@NotNull
 @NotNull Class<? extends Entity>[] entityClasses,
 @NotNull
 @NotNull Company company)

Returns a List<Entity> associated to the provided entityClasses and Company.

Parameters:

entityClasses - array of Class of Entity type filter.

company - Company filter.

Returns:

a List<Entity> associated to the provided entityClasses and Company.

getDataEntitiesByTables

public List<DataEntity> getDataEntitiesByTables(@NotNull
 @NotNull Set<String> tables,
 @NotNull
 @NotNull Company company)

Retrieves all DataEntity instances associated with the provided tables and Company.

Parameters:

tables - to retrieve models for.

company - The Company to retrieve models for.

Returns:

A set of DataEntity instances associated with the provided Company.

getAllDataAttributes

public List<DataAttribute> getAllDataAttributes(@NotNull
 @NotNull Class<? extends Entity>[] entityClasses,
 @NotNull
 @NotNull Company company)

Returns a List<DataAttribute> configured for the DataEntitys associated to the provided entityClasses and company.

Parameters:

entityClasses - the array of Class<Entity> about the models from which retrieve all configured DataAttributes.

company - the Company associated with the retrieved DataAttributes.

Returns:

a List<DataAttribute> configured for the DataEntitys associated to the provided entityClasses and company.

Throws:

NullPointerException - if entityClasses or company are null.

getAllDataAttributes

public List<DataAttribute> getAllDataAttributes(@NotNull
 @NotNull List<Entity> entities,
 @NotNull
 @NotNull Company company)

Returns a List<DataAttribute> configured for the DataEntitys associated to the provided entities and company.

Parameters:

entities - List<Entity> about the entities from which retrieve all configured DataAttributes.

company - Company associated with the retrieved DataAttributes.

Returns:

a List<DataAttribute> configured for the DataEntitys associated to the provided entities and company.

Throws:

NullPointerException - if entities or company are null.

getAllDataAttributesByAttributeName

public List<DataAttribute> getAllDataAttributesByAttributeName(@NotNull
 @NotNull Class<? extends Entity>[] entityClasses,
 @NotNull
 @NotNull String attributeName,
 @NotNull
 @NotNull Company company)

Returns a List<DataAttribute> configured for the DataEntitys associated to the provided entityClasses, attributeName and company.

Parameters:

entityClasses - the array of Class<Entity> about the models from which retrieve all configured DataAttributes.

attributeName - String about the attribute name.

company - the Company associated with the retrieved DataAttributes.

Returns:

a List<DataAttribute> configured for the DataEntitys associated to the provided entityClasses, attributeName and company.

Throws:

NullPointerException - if entityClasses or company are null.

getAllDataAttributes

public List<DataAttribute> getAllDataAttributes(@NotNull
 @NotNull Attribute extendedAttribute,
 @NotNull
 @NotNull Company company)

Returns a List<DataAttribute> configured for the DataEntitys associated to the provided extendedAttribute and company.

Parameters:

extendedAttribute - Attribute about the extended attribute.

company - the Company associated with the retrieved DataAttributes.

Returns:

a List<DataAttribute> configured for the DataEntitys associated to the provided extendedAttribute and company.

Throws:

NullPointerException - if entityClasses or company are null.

getAllDataAttributes

public List<DataAttribute> getAllDataAttributes(@NotNull
 @NotNull String extendedColumn,
 @NotNull
 @NotNull Company company)

Returns a List<DataAttribute> configured for the DataEntitys associated to the provided extendedColumn and company.

Parameters:

extendedColumn - String about the extended column name.

company - the Company associated with the retrieved DataAttributes.

Returns:

a List<DataAttribute> configured for the DataEntitys associated to the provided extendedColumn and company.

Throws:

NullPointerException - if entityClasses or company are null.

clearEntities

public void clearEntities(@NotNull
 @NotNull Company company)

Clears all entities associated with a company.

Parameters:

company - The company to clear entities for.

register

public void register(@NotNull
 @NotNull Entity entity)
              throws EDMConfigurationException

Registers a Entity.

Parameters:

entity - The Entity to register.

Throws:

EDMConfigurationException - if a model with the same name is already registered.

isExtendedColumn

public boolean isExtendedColumn(@NotNull
 @NotNull String column,
 @NotNull
 @NotNull Company company)

Returns true in case the column identified by the provided column is extended for the provided Company; false otherwise.

Parameters:

column - String about the column name filter.

company - Company about the company filter.

Returns:

true in case the column identified by the provided column is extended for the provided Company; false otherwise.

isExtendedColumn

public boolean isExtendedColumn(@NotNull
 @NotNull String column,
 @NotNull
 @NotNull Company company,
 List<Entity> entities)

Returns true in case the column identified by the provided column is extended for the provided Company and list of Entitys; false otherwise.

Parameters:

column - String about the column name filter.

company - Company about the company filter.

entities - List<Entity> about the EDM configuration defined for the provided company.

Returns:

true in case the column identified by the provided column is extended for the provided Company and list of Entitys; false otherwise.

isExtendedAttribute

public boolean isExtendedAttribute(@NotNull
 @NotNull String extendedAttribute,
 @NotNull
 @NotNull List<DataAttribute> dataAttributes,
 @NotNull
 @NotNull Company company)

Returns true in case the provided extendedAttribute was recognized as an EDM extended attribute; false otherwise.

Parameters:

extendedAttribute - String about the potential EDM extended attribute to check.

dataAttributes - List<DataAttribute> about the possible EDM data attributes.

Returns:

true in case the provided extendedAttribute was recognized as an EDM extended attribute; false otherwise.