Package org.radarbase.schema.validation.rules

Class RadarSchemaRules

java.lang.Object

org.radarbase.schema.validation.rules.RadarSchemaRules

All Implemented Interfaces:

SchemaRules

public class RadarSchemaRules
extends java.lang.Object
implements SchemaRules

Schema validation rules enforced for the RADAR-Schemas repository.

Constructor Summary

Constructors

Constructor	Description
RadarSchemaRules(ExcludeConfig config)
RadarSchemaRules(ExcludeConfig config, RadarSchemaFieldRules fieldRules)	RADAR-Schema validation rules.

Method Summary

Modifier and Type	Method	Description
Validator<org.apache.avro.Schema>	fields(Validator<SchemaField> validator)	Validates all fields of records.
SchemaFieldRules	getFieldRules()
java.util.Map<java.lang.String,org.apache.avro.Schema>	getSchemaStore()
Validator<org.apache.avro.Schema>	validateAvroData()
Validator<org.apache.avro.Schema>	validateName()	Checks schema name format.
Validator<org.apache.avro.Schema>	validateNameSpace()	Checks schema namespace format.
Validator<org.apache.avro.Schema>	validateNotTimeCompleted()	TODO.
Validator<org.apache.avro.Schema>	validateNotTimeReceived()	Checks that schemas should not have a timeReceived field.
Validator<org.apache.avro.Schema>	validateSchemaDocumentation()	Checks schema documentation presence and format.
Validator<org.apache.avro.Schema>	validateSymbols()	Checks that the symbols of enums have the required format.
Validator<org.apache.avro.Schema>	validateTime()	TODO.
Validator<org.apache.avro.Schema>	validateTimeCompleted()	TODO.
Validator<org.apache.avro.Schema>	validateTimeReceived()	Checks that schemas should have a timeReceived field.
Validator<org.apache.avro.Schema>	validateUniqueness()	Checks that schemas are unique compared to already validated schemas.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.radarbase.schema.validation.rules.SchemaRules

messageSchema, validateActiveSource, validateEnum, validateMonitor, validatePassive, validateRecord

Constructor Detail

RadarSchemaRules

public RadarSchemaRules(ExcludeConfig config,
                        RadarSchemaFieldRules fieldRules)

RADAR-Schema validation rules.

Parameters:

config - validation configuration

RadarSchemaRules

public RadarSchemaRules(ExcludeConfig config)

Method Detail

getFieldRules

public SchemaFieldRules getFieldRules()

Specified by:

getFieldRules in interface SchemaRules

validateUniqueness

public Validator<org.apache.avro.Schema> validateUniqueness()

Description copied from interface: SchemaRules

Checks that schemas are unique compared to already validated schemas.

Specified by:

validateUniqueness in interface SchemaRules

validateNameSpace

public Validator<org.apache.avro.Schema> validateNameSpace()

Description copied from interface: SchemaRules

Checks schema namespace format.

Specified by:

validateNameSpace in interface SchemaRules

validateName

public Validator<org.apache.avro.Schema> validateName()

Description copied from interface: SchemaRules

Checks schema name format.

Specified by:

validateName in interface SchemaRules

validateSchemaDocumentation

public Validator<org.apache.avro.Schema> validateSchemaDocumentation()

Description copied from interface: SchemaRules

Checks schema documentation presence and format.

Specified by:

validateSchemaDocumentation in interface SchemaRules

validateSymbols

public Validator<org.apache.avro.Schema> validateSymbols()

Description copied from interface: SchemaRules

Checks that the symbols of enums have the required format.

Specified by:

validateSymbols in interface SchemaRules

validateTime

public Validator<org.apache.avro.Schema> validateTime()

TODO.

Specified by:

validateTime in interface SchemaRules

Returns:

TODO

validateTimeCompleted

public Validator<org.apache.avro.Schema> validateTimeCompleted()

TODO.

Specified by:

validateTimeCompleted in interface SchemaRules

Returns:

TODO

validateNotTimeCompleted

public Validator<org.apache.avro.Schema> validateNotTimeCompleted()

TODO.

Specified by:

validateNotTimeCompleted in interface SchemaRules

Returns:

TODO

validateTimeReceived

public Validator<org.apache.avro.Schema> validateTimeReceived()

Description copied from interface: SchemaRules

Checks that schemas should have a timeReceived field.

Specified by:

validateTimeReceived in interface SchemaRules

validateNotTimeReceived

public Validator<org.apache.avro.Schema> validateNotTimeReceived()

Description copied from interface: SchemaRules

Checks that schemas should not have a timeReceived field.

Specified by:

validateNotTimeReceived in interface SchemaRules

validateAvroData

public Validator<org.apache.avro.Schema> validateAvroData()

Specified by:

validateAvroData in interface SchemaRules

fields

public Validator<org.apache.avro.Schema> fields(Validator<SchemaField> validator)

Description copied from interface: SchemaRules

Validates all fields of records. Validation will fail on non-record types or records with no fields.

Specified by:

fields in interface SchemaRules

getSchemaStore

public java.util.Map<java.lang.String,org.apache.avro.Schema> getSchemaStore()