de.ipcon.schema

Class SchemaUtils

java.lang.Object

de.ipcon.schema.SchemaUtils

public final class SchemaUtils
extends java.lang.Object

Utility methods for entity graph reachability analysis and BO network inspection. Serves as the Java companion to legacy NetRexx SchemaTools.

Provides graph traversal over persistent and unlazied entity relations, polymorphic class-exclusion filtering and runtime inspection of loaded BO graphs. All methods are stateless and thread-safe.

See Also:

SchemaI, EntityI, BOI

Method Summary

Modifier and Type	Method and Description
static java.util.Map<EntityI,java.util.Set<AttributeI>>	expandUnlazyAttributesForSubEntities(java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyAttrs) Expands an unlazy configuration map across all concrete sub-entities (polymorphic subclasses).
static java.util.Set<java.lang.Class<?>>	findReachableClasses(SchemaI schema, java.util.Collection<java.lang.Class<?>> rootKeepClasses, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap) Resolves a set of all BO classes reachable from the given root classes and unlazy relations.
static java.lang.Class<?>[]	findReachableClassesAsArray(SchemaI schema, java.lang.Class<?>[] rootKeepClasses, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap) Resolves an array of all BO classes reachable from the given root classes and unlazy relations.
static java.util.Set<EntityI>	findReachableEntities(SchemaI schema, java.lang.Class<?>[] rootKeepClasses, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap) Resolves all reachable entities starting from an array of root classes.
static java.util.Set<EntityI>	findReachableEntities(SchemaI schema, java.util.Collection<java.lang.Class<?>> rootKeepClasses, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap) Resolves schema entities for root classes and computes all reachable entities using empty class exclusions.
static java.util.Set<EntityI>	findReachableEntities(SchemaI schema, java.util.Collection<java.lang.Class<?>> rootKeepClasses, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap, java.util.Map<java.lang.Class<?>,java.lang.Class<?>> explicitIgnores) Resolves schema entities for root classes and computes all reachable entities, filtering by explicit class exclusions.
static java.util.Set<EntityI>	findReachableEntities(java.util.Set<EntityI> startingPoints, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap, java.util.Map<java.lang.Class<?>,java.lang.Class<?>> explicitIgnores) Computes all entities reachable from starting points by traversing persistent 1-n and n-1 relations and configured unlazy many-relations, excluding classes in explicitIgnores.
static java.util.Set<AttributeI>	findUnlazyAttributes(EntityI baseEntity, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyAttrs) Filters an unlazy attributes map for entries applicable to a base entity or its super-entities, retaining only persistent many-relations (1-n, n-m).
static java.util.Set<AttributeI>	findUnlazyAttributes(SchemaI schema, java.lang.Class<? extends BOI> clazz, java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyAttrs) Resolves unlazy attributes applicable to a BO class by looking up its entity in the schema.
static java.util.Collection<java.lang.String>	findUnlazyPaths(BOI bo, java.util.Set<java.lang.String> recursionGuard, boolean onlyManyRelations) Recursively inspects a loaded BO graph and returns formatted path descriptors for all currently unlazied relations in memory.

Methods inherited from class java.lang.Object

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

Method Detail

findReachableClassesAsArray

public static java.lang.Class<?>[] findReachableClassesAsArray(SchemaI schema,
                                                               java.lang.Class<?>[] rootKeepClasses,
                                                               java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap)

Resolves an array of all BO classes reachable from the given root classes and unlazy relations.

Parameters:

schema - the schema used to look up entity definitions

rootKeepClasses - root classes to start traversal from

unlazyMap - mapping of entities to their unlazied relations

Returns:

an array of reachable entity classes; never null

findReachableClasses

public static java.util.Set<java.lang.Class<?>> findReachableClasses(SchemaI schema,
                                                                     java.util.Collection<java.lang.Class<?>> rootKeepClasses,
                                                                     java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap)

Resolves a set of all BO classes reachable from the given root classes and unlazy relations.

Parameters:

schema - the schema used to look up entity definitions

rootKeepClasses - collection of root classes to start traversal from

unlazyMap - mapping of entities to their unlazied relations

Returns:

a set of reachable entity classes; never null

findReachableEntities

public static java.util.Set<EntityI> findReachableEntities(SchemaI schema,
                                                           java.util.Collection<java.lang.Class<?>> rootKeepClasses,
                                                           java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap,
                                                           java.util.Map<java.lang.Class<?>,java.lang.Class<?>> explicitIgnores)

Resolves schema entities for root classes and computes all reachable entities, filtering by explicit class exclusions.

Classes without a corresponding schema entity or not implementing BOI are logged and skipped.

Parameters:

schema - the schema used to look up entity definitions

rootKeepClasses - collection of root classes to start traversal from

unlazyMap - mapping of entities to their unlazied relations

explicitIgnores - classes to exclude from reachability tracking

Returns:

a set of reachable entity instances; never null

findReachableEntities

public static java.util.Set<EntityI> findReachableEntities(SchemaI schema,
                                                           java.lang.Class<?>[] rootKeepClasses,
                                                           java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap)

Resolves all reachable entities starting from an array of root classes.

Parameters:

schema - the schema used to look up entity definitions

rootKeepClasses - array of root classes to start traversal from

unlazyMap - mapping of entities to their unlazied relations

Returns:

a set of reachable entity instances; never null

findReachableEntities

public static java.util.Set<EntityI> findReachableEntities(SchemaI schema,
                                                           java.util.Collection<java.lang.Class<?>> rootKeepClasses,
                                                           java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap)

Resolves schema entities for root classes and computes all reachable entities using empty class exclusions.

Parameters:

schema - the schema used to look up entity definitions

rootKeepClasses - collection of root classes to start traversal from

unlazyMap - mapping of entities to their unlazied relations

Returns:

a set of reachable entity instances; never null

findReachableEntities

public static java.util.Set<EntityI> findReachableEntities(java.util.Set<EntityI> startingPoints,
                                                           java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyMap,
                                                           java.util.Map<java.lang.Class<?>,java.lang.Class<?>> explicitIgnores)

Computes all entities reachable from starting points by traversing persistent 1-n and n-1 relations and configured unlazy many-relations, excluding classes in explicitIgnores.

Parameters:

startingPoints - root entry entities in the schema graph

unlazyMap - relations expected to be unlazied per entity

explicitIgnores - classes to exclude from reachability tracking

Returns:

an unmodifiable set of reachable schema entities; never null

expandUnlazyAttributesForSubEntities

public static java.util.Map<EntityI,java.util.Set<AttributeI>> expandUnlazyAttributesForSubEntities(java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyAttrs)

Expands an unlazy configuration map across all concrete sub-entities (polymorphic subclasses).

Parameters:

unlazyAttrs - source map of entities to configured unlazy attributes

Returns:

expanded map including base entities and all concrete sub-entities; never null

findUnlazyAttributes

public static java.util.Set<AttributeI> findUnlazyAttributes(SchemaI schema,
                                                             java.lang.Class<? extends BOI> clazz,
                                                             java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyAttrs)

Resolves unlazy attributes applicable to a BO class by looking up its entity in the schema.

Parameters:

schema - schema used to look up the entity definition

clazz - BO class to resolve attributes for

unlazyAttrs - source unlazy configuration mapping

Returns:

filtered set of matching persistent many-relation attributes; never null

findUnlazyAttributes

public static java.util.Set<AttributeI> findUnlazyAttributes(EntityI baseEntity,
                                                             java.util.Map<EntityI,java.util.Set<AttributeI>> unlazyAttrs)

Filters an unlazy attributes map for entries applicable to a base entity or its super-entities, retaining only persistent many-relations (1-n, n-m).

Parameters:

baseEntity - target entity to resolve attributes for; non-null

unlazyAttrs - source unlazy configuration mapping

Returns:

matching persistent many-relation attributes; never null

findUnlazyPaths

public static java.util.Collection<java.lang.String> findUnlazyPaths(BOI bo,
                                                                     java.util.Set<java.lang.String> recursionGuard,
                                                                     boolean onlyManyRelations)

Recursively inspects a loaded BO graph and returns formatted path descriptors for all currently unlazied relations in memory.

Usage example:

 Collection<String> before = SchemaUtils.findUnlazyPaths(bo, null, false);
 // ... execute calculation ...
 Collection<String> after = SchemaUtils.findUnlazyPaths(bo, null, false);
 Set<String> delta = new HashSet<>(after);
 delta.removeAll(before);
 log.info("Newly unlazied relations: " + delta);
 

Parameters:

bo - root BO to inspect (null returns an empty collection)

recursionGuard - set tracking visited relation keys to prevent cycles; pass null initially

onlyManyRelations - true to inspect only collection relations (1-n, n-m); false includes n-1

Returns:

formatted relation paths, e.g. "EntityName[123].attributeName"; never null