public class | source

Validator

You can directly use instance of this class. validator

A validator that can be used to validate the following objects:

<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-Project">Project</a>
<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-Schema">Schema</a>
<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-Column">Column</a>
<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-Changes">Changes</a>
<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-Change">Change</a>
<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-DataInfo">DataInfo</a>
<a href="https://doc.esdoc.org/github.com/schema-mapper/spec/typedef/index.html#static-typedef-Item">Item</a>

Method Summary

Public Methods
public	getValidChangeTypes(): Array Get the change types that are valid to use
public	getValidColumnTypes(): Array Get the column types that are valid to use
public	respond(errors: Array): ValidationResult Return a ValidationResult from an errors array
public	validateChange(change: Change): ValidationResult Validate a single Change
public	validateChanges(changes: Changes): ValidationResult Validate Changes
public	validateColumn(projectId: String, schemaId: String, columnId: String, column: Column): Array Validate a column
public	validateColumnCreateChange(change: ColumnCreateChange): ValidationResult Validate a ColumnCreateChange
public	validateColumnRemoveChange(change: ColumnRemoveChange): ValidationResult Validate a ColumnRemoveChange
public	validateColumnRenameChange(change: ColumnRenameChange): ValidationResult Validate a ColumnRenameChange
public	validateColumnTypechangeChange(change: ColumnTypechangeChange): ValidationResult Validate a ColumnTypechangeChange
public	validateDataInfo(dataInfo: DataInfo): ValidationResult Validate a DataInfo object
public	validateItem(item: Item, schema: Schema): ValidationResult Validate an item
public	validateProject(projectId: String, project: Project): ValidationResult Validate a project
public	validateProjectCreateChange(change: ProjectCreateChange): ValidationResult Validate a ProjectCreateChange
public	validateProjectTagChange(change: ProjectTagChange): ValidationResult Validate a ProjectTagChange
public	validateProjects(projects: Object): ValidationResult Validate projects
public	validateSchema(projectId: String, schemaId: String, schema: Schema): ValidationResult Validate a Schema
public	validateSchemaCreateChange(change: SchemaCreateChange): ValidationResult Validate a SchemaCreateChange
public	validateSchemaRemoveChange(change: SchemaRemoveChange): ValidationResult Validate a SchemaRemoveChange
public	validateSchemaRenameChange(change: SchemaRenameChange): ValidationResult Validate a SchemaRenameChange
public	validateType(value: *, column: Column): ValidationResult Validate the type of a value

Public Methods

public getValidChangeTypes(): Array source

Get the change types that are valid to use

Return:

Array

An array containing all of schema-mapper's change types

public getValidColumnTypes(): Array source

Get the column types that are valid to use

Return:

Array

An array containing all of schema-mapper's types

public respond(errors: Array): ValidationResult source

Return a ValidationResult from an errors array

Params:

Name	Type	Attribute	Description
errors	Array		An array of error messages

Return:

ValidationResult

An object the validation result

public validateChange(change: Change): ValidationResult source

Validate a single Change

Params:

Name	Type	Attribute	Description
change	Change		A Change

Return:

ValidationResult

A ValidationResult

public validateChanges(changes: Changes): ValidationResult source

Validate Changes

Params:

Name	Type	Attribute	Description
changes	Changes		A Changes array

Return:

ValidationResult

A ValidationResult

public validateColumn(projectId: String, schemaId: String, columnId: String, column: Column): Array source

Validate a column

Params:

Name	Type	Attribute	Description
projectId	String		The id of the project
schemaId	String		The id of the schema
columnId	String		The id of the column
column	Column		A column to validate

Return:

Array

An array of errors

public validateColumnCreateChange(change: ColumnCreateChange): ValidationResult source

Validate a ColumnCreateChange

Params:

Name	Type	Attribute	Description
change	ColumnCreateChange

Return:

ValidationResult

A ValidationResult

public validateColumnRemoveChange(change: ColumnRemoveChange): ValidationResult source

Validate a ColumnRemoveChange

Params:

Name	Type	Attribute	Description
change	ColumnRemoveChange

Return:

ValidationResult

A ValidationResult

public validateColumnRenameChange(change: ColumnRenameChange): ValidationResult source

Validate a ColumnRenameChange

Params:

Name	Type	Attribute	Description
change	ColumnRenameChange

Return:

ValidationResult

A ValidationResult

public validateColumnTypechangeChange(change: ColumnTypechangeChange): ValidationResult source

Validate a ColumnTypechangeChange

Params:

Name	Type	Attribute	Description
change	ColumnTypechangeChange

Return:

ValidationResult

A ValidationResult

public validateDataInfo(dataInfo: DataInfo): ValidationResult source

Validate a DataInfo object

Params:

Name	Type	Attribute	Description
dataInfo	DataInfo		A DataInfo object

Return:

ValidationResult

A ValidationResult

public validateItem(item: Item, schema: Schema): ValidationResult source

Validate an item

Params:

Name	Type	Attribute	Description
item	Item		An object with data
schema	Schema		The schema that matches the version of this data

Return:

ValidationResult

public validateProject(projectId: String, project: Project): ValidationResult source

Validate a project

Params:

Name	Type	Attribute	Description
projectId	String
project	Project

Return:

ValidationResult

public validateProjectCreateChange(change: ProjectCreateChange): ValidationResult source

Validate a ProjectCreateChange

Params:

Name	Type	Attribute	Description
change	ProjectCreateChange		change

Return:

ValidationResult

A ValidationResult

public validateProjectTagChange(change: ProjectTagChange): ValidationResult source

Validate a ProjectTagChange

Params:

Name	Type	Attribute	Description
change	ProjectTagChange

Return:

ValidationResult

A ValidationResult

public validateProjects(projects: Object): ValidationResult source

Validate projects

Params:

Name	Type	Attribute	Description
projects	Object		An object where the keys contain the projectId and the value is of type Project

Return:

ValidationResult

public validateSchema(projectId: String, schemaId: String, schema: Schema): ValidationResult source

Validate a Schema

Params:

Name	Type	Attribute	Description
projectId	String		The project id
schemaId	String		The schema id
schema	Schema		A Schema

Return:

ValidationResult

A ValidationResult

public validateSchemaCreateChange(change: SchemaCreateChange): ValidationResult source

Validate a SchemaCreateChange

Params:

Name	Type	Attribute	Description
change	SchemaCreateChange

Return:

ValidationResult

A ValidationResult

public validateSchemaRemoveChange(change: SchemaRemoveChange): ValidationResult source

Validate a SchemaRemoveChange

Params:

Name	Type	Attribute	Description
change	SchemaRemoveChange

Return:

ValidationResult

A ValidationResult

public validateSchemaRenameChange(change: SchemaRenameChange): ValidationResult source

Validate a SchemaRenameChange

Params:

Name	Type	Attribute	Description
change	SchemaRenameChange

Return:

ValidationResult

A ValidationResult

public validateType(value: *, column: Column): ValidationResult source

Validate the type of a value

Params:

Name	Type	Attribute	Description
value	*		The value to check
column	Column		The column for this value

Return:

ValidationResult