Package ch.rswk.meta.engine

Class MetaSchema

java.lang.Object

ch.rswk.meta.engine.MetaSchema

@Singleton
public class MetaSchema
extends Object

MetaSchema handles generating Lucene Document fields from JSON schemas. Defines built in meta schema types and the mechanism for using them in JSON schemas with JsonSchemaFactory. Provides map of PointsConfig in pointsConfig() for searching numeric Lucene fields.

Built in schema types available for MetaType and MetaAction schemas:

• meta:date, see MetaSchema.DateFieldGenerator
• meta:datetime, see MetaSchema.DateTimeFieldGenerator
• meta:file, see MetaSchema.FileFieldGenerator
• meta:geopoint, see MetaSchema.GeoPointFieldGenerator
• meta:id, see MetaSchema.IdFieldGenerator
• meta:uuid, see MetaSchema.UuidFieldGenerator

In addition to the built in types, generation of Lucene fields can be customized in a number of ways:

• Schemas can define their own reusable types using definitions
• Application wide custom schema types can be defined using MetaSchema.AbstractSchemaFieldGenerator
• Field name specific generation using MetaSchema.AbstractNamedFieldGenerator
• MetaType specific generation of fields using MetaSchema.AbstractMetaTypeFieldGenerator

All custom generators instances must be injected.

See Also:

• Model.newTypeSchema(boolean, String, String, String, Set, Set)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetaSchema.AbstractMetaTypeFieldGenerator	MetaTypeFieldGenerator generates Lucene fields when encountering an object of the specified type.
static class	MetaSchema.AbstractNamedFieldGenerator	NamedFieldGenerator generates Lucene fields when ecnountering a field with the specified name.
static class	MetaSchema.AbstractSchemaFieldGenerator
private static class	MetaSchema.BooleanFieldGenerator
private static class	MetaSchema.DateFieldGenerator
private static class	MetaSchema.DateTimeFieldGenerator
static interface	MetaSchema.FieldGenerator
private static class	MetaSchema.FileFieldGenerator
private static class	MetaSchema.GeoPointFieldGenerator
private static final class	MetaSchema.HttpUriFetcher
private static class	MetaSchema.IdFieldGenerator
private static class	MetaSchema.IllegalFieldGenerator
private static final record	MetaSchema.IndexableField
private static class	MetaSchema.IntegerFieldGenerator
private static final class	MetaSchema.MetaUriFetcher
private static class	MetaSchema.NumberFieldGenerator
private static class	MetaSchema.StringFieldGenerator
private static final class	MetaSchema.UriFactory
private static class	MetaSchema.UuidFieldGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,org.apache.lucene.analysis.Analyzer>	analyzers
private static final String	ANY_OF_VALUE
private static final String	ARRAY_TYPE
private static final Map<String,org.apache.lucene.analysis.Analyzer>	DEFAULT_ANALYZERS
private static final Map<String,org.apache.lucene.queryparser.flexible.standard.config.PointsConfig>	DEFAULT_POINT_CONFIGS
private static final String	DEFINITIONS_REF_PREFIX
private final com.networknt.schema.JsonSchema	draftSchema
private final Map<String,MetaSchema.FieldGenerator>	generatorsByFieldName
private final Map<String,MetaSchema.AbstractMetaTypeFieldGenerator>	generatorsByMetaTypeId
private final Map<String,MetaSchema.AbstractSchemaFieldGenerator>	generatorsByTypeRef
private static final MetaSchema.FieldGenerator	ILLEGAL_FIELD_GENERATOR
private static final Set<String>	ILLEGAL_FIELD_NAMES
private static final String	ITEMS_VALUE
private static final String	JSON_DRAFT_SCHEMA_URI
private static final org.slf4j.Logger	LOG
private static final String	META_URI_SCHEME
private static final String	OBJECT_TYPE
private static final String	ONE_OF_VALUE
private final Map<String,org.apache.lucene.queryparser.flexible.standard.config.PointsConfig>	pointConfigs
private static final String	PROPERTIES_VALUE
private static final String	REF_VALUE
private static final Set<MetaSchema.AbstractSchemaFieldGenerator>	SCHEMA_GENERATORS
private static final String	SCHEMA_ID_FORMAT
private final com.networknt.schema.JsonSchemaFactory	schemaFactory
private static final String	SIMPLE_SCHEMA_FORMAT
private static final String	TYPE_VALUE

Constructor Summary

Constructors

Constructor	Description
MetaSchema(Set<MetaSchema.FieldGenerator> generators)

Method Summary

Modifier and Type	Method	Description
Map<String,org.apache.lucene.analysis.Analyzer>	analyzers()
private void	appendFieldsRecursive(org.apache.lucene.document.Document document, String metaId, @Nullable String name, com.fasterxml.jackson.databind.JsonNode node, Set<String> sortableFields)
void	appendLogDataFields(org.apache.lucene.document.Document document, MetaLog meta)
void	appendObjectValueFields(org.apache.lucene.document.Document document, MetaObject meta, Set<String> sortableFields)
private com.networknt.schema.JsonSchemaFactory	buildJsonSchemaFactory()
com.networknt.schema.JsonSchema	draftSchema()
private static Optional<String>	getFieldTypeRecursive(com.fasterxml.jackson.databind.JsonNode field)
com.networknt.schema.JsonSchema	getSchema(com.fasterxml.jackson.databind.JsonNode schema)
com.networknt.schema.JsonSchema	getSchema(URI uri)
private static void	indexFieldsRecursive(Consumer<MetaSchema.IndexableField> consumer, com.fasterxml.jackson.databind.JsonNode node, @Nullable Consumer<MetaSchema.IndexableField> rootConsumer)
void	indexMetaType(MetaType type)
private void	indexSchema(com.fasterxml.jackson.databind.JsonNode schema)
static String	newSchema(@Nullable String id, String schema)
Map<String,org.apache.lucene.queryparser.flexible.standard.config.PointsConfig>	pointsConfig()
private void	registerGenerators(Set<MetaSchema.FieldGenerator> generators)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

ANY_OF_VALUE

private static final String ANY_OF_VALUE

ARRAY_TYPE

private static final String ARRAY_TYPE

DEFAULT_ANALYZERS

private static final Map<String,org.apache.lucene.analysis.Analyzer> DEFAULT_ANALYZERS

DEFAULT_POINT_CONFIGS

private static final Map<String,org.apache.lucene.queryparser.flexible.standard.config.PointsConfig> DEFAULT_POINT_CONFIGS

DEFINITIONS_REF_PREFIX

private static final String DEFINITIONS_REF_PREFIX

ILLEGAL_FIELD_GENERATOR

private static final MetaSchema.FieldGenerator ILLEGAL_FIELD_GENERATOR

ILLEGAL_FIELD_NAMES

private static final Set<String> ILLEGAL_FIELD_NAMES

ITEMS_VALUE

private static final String ITEMS_VALUE

JSON_DRAFT_SCHEMA_URI

private static final String JSON_DRAFT_SCHEMA_URI

META_URI_SCHEME

private static final String META_URI_SCHEME

See Also:

• Constant Field Values

OBJECT_TYPE

private static final String OBJECT_TYPE

ONE_OF_VALUE

private static final String ONE_OF_VALUE

PROPERTIES_VALUE

private static final String PROPERTIES_VALUE

REF_VALUE

private static final String REF_VALUE

SCHEMA_GENERATORS

private static final Set<MetaSchema.AbstractSchemaFieldGenerator> SCHEMA_GENERATORS

SCHEMA_ID_FORMAT

private static final String SCHEMA_ID_FORMAT

See Also:

• Constant Field Values

SIMPLE_SCHEMA_FORMAT

private static final String SIMPLE_SCHEMA_FORMAT

See Also:

• Constant Field Values

TYPE_VALUE

private static final String TYPE_VALUE

analyzers

private final Map<String,org.apache.lucene.analysis.Analyzer> analyzers

draftSchema

private final com.networknt.schema.JsonSchema draftSchema

generatorsByFieldName

private final Map<String,MetaSchema.FieldGenerator> generatorsByFieldName

generatorsByMetaTypeId

private final Map<String,MetaSchema.AbstractMetaTypeFieldGenerator> generatorsByMetaTypeId

generatorsByTypeRef

private final Map<String,MetaSchema.AbstractSchemaFieldGenerator> generatorsByTypeRef

pointConfigs

private final Map<String,org.apache.lucene.queryparser.flexible.standard.config.PointsConfig> pointConfigs

schemaFactory

private final com.networknt.schema.JsonSchemaFactory schemaFactory

Constructor Details

MetaSchema

@Inject
public MetaSchema(Set<MetaSchema.FieldGenerator> generators)

Method Details

analyzers

public Map<String,org.apache.lucene.analysis.Analyzer> analyzers()

appendFieldsRecursive

private void appendFieldsRecursive(org.apache.lucene.document.Document document,
 String metaId,
 @Nullable String name,
 com.fasterxml.jackson.databind.JsonNode node,
 Set<String> sortableFields)

appendLogDataFields

public void appendLogDataFields(org.apache.lucene.document.Document document,
 MetaLog meta)

appendObjectValueFields

public void appendObjectValueFields(org.apache.lucene.document.Document document,
 MetaObject meta,
 Set<String> sortableFields)

buildJsonSchemaFactory

private com.networknt.schema.JsonSchemaFactory buildJsonSchemaFactory()

draftSchema

public com.networknt.schema.JsonSchema draftSchema()

getFieldTypeRecursive

private static Optional<String> getFieldTypeRecursive(com.fasterxml.jackson.databind.JsonNode field)

getSchema

public com.networknt.schema.JsonSchema getSchema(URI uri)

getSchema

public com.networknt.schema.JsonSchema getSchema(com.fasterxml.jackson.databind.JsonNode schema)

indexFieldsRecursive

private static void indexFieldsRecursive(Consumer<MetaSchema.IndexableField> consumer,
 com.fasterxml.jackson.databind.JsonNode node,
 @Nullable Consumer<MetaSchema.IndexableField> rootConsumer)

indexMetaType

public void indexMetaType(MetaType type)

indexSchema

private void indexSchema(com.fasterxml.jackson.databind.JsonNode schema)

newSchema

public static String newSchema(@Nullable String id,
 String schema)

pointsConfig

public Map<String,org.apache.lucene.queryparser.flexible.standard.config.PointsConfig> pointsConfig()

registerGenerators

private void registerGenerators(Set<MetaSchema.FieldGenerator> generators)