JSON schema document. More...

#include <schema.h>

Collaboration diagram for GenericSchemaDocument< ValueT, Allocator >:

Classes
struct	SchemaRefEntry
struct	SchemaEntry

Public Types
typedef ValueT	ValueType
typedef IGenericRemoteSchemaDocumentProvider< GenericSchemaDocument >	IRemoteSchemaDocumentProviderType
typedef Allocator	AllocatorType
typedef ValueType::EncodingType	EncodingType
typedef EncodingType::Ch	Ch
typedef internal::Schema< GenericSchemaDocument >	SchemaType
typedef GenericPointer< ValueType, Allocator >	PointerType
typedef GenericValue< EncodingType, Allocator >	URIType

Public Member Functions
	GenericSchemaDocument (const ValueType &document, const Ch uri=0, SizeType uriLength=0, IRemoteSchemaDocumentProviderType remoteProvider=0, Allocator *allocator=0)
	Constructor.
	~GenericSchemaDocument ()
	Destructor.
const URIType &	GetURI () const
const SchemaType &	GetRoot () const
	Get the root schema.

Private Member Functions
	GenericSchemaDocument (const GenericSchemaDocument &)
	Prohibit copying.
GenericSchemaDocument &	operator= (const GenericSchemaDocument &)
	Prohibit assignment.
void	CreateSchemaRecursive (const SchemaType **schema, const PointerType &pointer, const ValueType &v, const ValueType &document)
void	CreateSchema (const SchemaType **schema, const PointerType &pointer, const ValueType &v, const ValueType &document)
bool	HandleRefSchema (const PointerType &source, const SchemaType **schema, const ValueType &v, const ValueType &document)
const SchemaType *	GetSchema (const PointerType &pointer) const
PointerType	GetPointer (const SchemaType *schema) const
const SchemaType *	GetTypeless () const

Private Attributes
IRemoteSchemaDocumentProviderType *	remoteProvider_
Allocator *	allocator_
Allocator *	ownAllocator_
const SchemaType *	root_
	Root schema.
SchemaType *	typeless_
internal::Stack< Allocator >	schemaMap_
internal::Stack< Allocator >	schemaRef_
URIType	uri_

Static Private Attributes
static const size_t	kInitialSchemaMapSize = 64
static const size_t	kInitialSchemaRefSize = 64

Friends
class	internal::Schema< GenericSchemaDocument >
template<typename, typename, typename>
class	GenericSchemaValidator

Detailed Description

template<typename ValueT, typename Allocator = CrtAllocator>
class GenericSchemaDocument< ValueT, Allocator >

JSON schema document.

A JSON schema document is a compiled version of a JSON schema. It is basically a tree of internal::Schema.

Note: This is an immutable class (i.e. its instance cannot be modified after construction).

Template Parameters

ValueT	Type of JSON value (e.g. `Value` ), which also determine the encoding.
Allocator	Allocator type for allocating memory of this document.

Member Typedef Documentation

◆ AllocatorType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef Allocator GenericSchemaDocument< ValueT, Allocator >::AllocatorType

◆ Ch

template<typename ValueT, typename Allocator = CrtAllocator>

typedef EncodingType::Ch GenericSchemaDocument< ValueT, Allocator >::Ch

◆ EncodingType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef ValueType::EncodingType GenericSchemaDocument< ValueT, Allocator >::EncodingType

◆ IRemoteSchemaDocumentProviderType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef IGenericRemoteSchemaDocumentProvider<GenericSchemaDocument> GenericSchemaDocument< ValueT, Allocator >::IRemoteSchemaDocumentProviderType

◆ PointerType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef GenericPointer<ValueType, Allocator> GenericSchemaDocument< ValueT, Allocator >::PointerType

◆ SchemaType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef internal::Schema<GenericSchemaDocument> GenericSchemaDocument< ValueT, Allocator >::SchemaType

◆ URIType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef GenericValue<EncodingType, Allocator> GenericSchemaDocument< ValueT, Allocator >::URIType

◆ ValueType

template<typename ValueT, typename Allocator = CrtAllocator>

typedef ValueT GenericSchemaDocument< ValueT, Allocator >::ValueType

Constructor & Destructor Documentation

◆ GenericSchemaDocument() [1/2]

template<typename ValueT, typename Allocator = CrtAllocator>

GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument	(	const ValueType &	document,
		const Ch *	uri = 0,
		SizeType	uriLength = 0,
		IRemoteSchemaDocumentProviderType *	remoteProvider = 0,
		Allocator *	allocator = 0 )

inlineexplicit

Constructor.

Compile a JSON document into schema document.

Parameters

document	A JSON document as source.
uri	The base URI of this schema document for purposes of violation reporting.
uriLength	Length of `name`, in code points.
remoteProvider	An optional remote schema document provider for resolving remote reference. Can be null.
allocator	An optional allocator instance for allocating memory. Can be null.

◆ ~GenericSchemaDocument()

template<typename ValueT, typename Allocator = CrtAllocator>

GenericSchemaDocument< ValueT, Allocator >::~GenericSchemaDocument ( )

inline

Destructor.

◆ GenericSchemaDocument() [2/2]

template<typename ValueT, typename Allocator = CrtAllocator>

GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument ( const GenericSchemaDocument< ValueT, Allocator > & )

private

Prohibit copying.

Member Function Documentation

◆ CreateSchema()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::CreateSchema	(	const SchemaType **	schema,
		const PointerType &	pointer,
		const ValueType &	v,
		const ValueType &	document )

inlineprivate

◆ CreateSchemaRecursive()

template<typename ValueT, typename Allocator = CrtAllocator>

void GenericSchemaDocument< ValueT, Allocator >::CreateSchemaRecursive	(	const SchemaType **	schema,
		const PointerType &	pointer,
		const ValueType &	v,
		const ValueType &	document )

inlineprivate

◆ GetPointer()

template<typename ValueT, typename Allocator = CrtAllocator>

PointerType GenericSchemaDocument< ValueT, Allocator >::GetPointer ( const SchemaType * schema ) const

inlineprivate

◆ GetRoot()

template<typename ValueT, typename Allocator = CrtAllocator>

const SchemaType & GenericSchemaDocument< ValueT, Allocator >::GetRoot ( ) const

inline

Get the root schema.

◆ GetSchema()

template<typename ValueT, typename Allocator = CrtAllocator>

const SchemaType * GenericSchemaDocument< ValueT, Allocator >::GetSchema ( const PointerType & pointer ) const

inlineprivate

◆ GetTypeless()

template<typename ValueT, typename Allocator = CrtAllocator>

const SchemaType * GenericSchemaDocument< ValueT, Allocator >::GetTypeless ( ) const

inlineprivate

◆ GetURI()

template<typename ValueT, typename Allocator = CrtAllocator>

const URIType & GenericSchemaDocument< ValueT, Allocator >::GetURI ( ) const

inline

◆ HandleRefSchema()

template<typename ValueT, typename Allocator = CrtAllocator>

bool GenericSchemaDocument< ValueT, Allocator >::HandleRefSchema	(	const PointerType &	source,
		const SchemaType **	schema,
		const ValueType &	v,
		const ValueType &	document )

inlineprivate

◆ operator=()

template<typename ValueT, typename Allocator = CrtAllocator>

GenericSchemaDocument & GenericSchemaDocument< ValueT, Allocator >::operator= ( const GenericSchemaDocument< ValueT, Allocator > & )

private

Prohibit assignment.

◆ GenericSchemaValidator

template<typename ValueT, typename Allocator = CrtAllocator>

template<typename, typename, typename>

friend class GenericSchemaValidator

friend

◆ internal::Schema< GenericSchemaDocument >

template<typename ValueT, typename Allocator = CrtAllocator>

friend class internal::Schema< GenericSchemaDocument >

friend

Member Data Documentation

◆ allocator_

template<typename ValueT, typename Allocator = CrtAllocator>

Allocator* GenericSchemaDocument< ValueT, Allocator >::allocator_

private

◆ kInitialSchemaMapSize

template<typename ValueT, typename Allocator = CrtAllocator>

const size_t GenericSchemaDocument< ValueT, Allocator >::kInitialSchemaMapSize = 64

staticprivate

◆ kInitialSchemaRefSize

template<typename ValueT, typename Allocator = CrtAllocator>

const size_t GenericSchemaDocument< ValueT, Allocator >::kInitialSchemaRefSize = 64

staticprivate

◆ ownAllocator_

template<typename ValueT, typename Allocator = CrtAllocator>

Allocator* GenericSchemaDocument< ValueT, Allocator >::ownAllocator_

private

◆ remoteProvider_

template<typename ValueT, typename Allocator = CrtAllocator>

IRemoteSchemaDocumentProviderType* GenericSchemaDocument< ValueT, Allocator >::remoteProvider_

private

◆ root_

template<typename ValueT, typename Allocator = CrtAllocator>

const SchemaType* GenericSchemaDocument< ValueT, Allocator >::root_

private

Root schema.

◆ schemaMap_

template<typename ValueT, typename Allocator = CrtAllocator>

internal::Stack<Allocator> GenericSchemaDocument< ValueT, Allocator >::schemaMap_

private

◆ schemaRef_

template<typename ValueT, typename Allocator = CrtAllocator>

internal::Stack<Allocator> GenericSchemaDocument< ValueT, Allocator >::schemaRef_

private

◆ typeless_

template<typename ValueT, typename Allocator = CrtAllocator>

SchemaType* GenericSchemaDocument< ValueT, Allocator >::typeless_

private

◆ uri_

template<typename ValueT, typename Allocator = CrtAllocator>

URIType GenericSchemaDocument< ValueT, Allocator >::uri_

private

The documentation for this class was generated from the following files:

external/rapidjson/include/rapidjson/fwd.h
external/rapidjson/include/rapidjson/schema.h

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ AllocatorType

◆ Ch

◆ EncodingType

◆ IRemoteSchemaDocumentProviderType

◆ PointerType

◆ SchemaType

◆ URIType

◆ ValueType

Constructor & Destructor Documentation

◆ GenericSchemaDocument() [1/2]

◆ ~GenericSchemaDocument()

◆ GenericSchemaDocument() [2/2]

Member Function Documentation

◆ CreateSchema()

◆ CreateSchemaRecursive()

◆ GetPointer()

◆ GetRoot()

◆ GetSchema()

◆ GetTypeless()

◆ GetURI()

◆ HandleRefSchema()

◆ operator=()

Friends And Related Symbol Documentation

◆ GenericSchemaValidator

◆ internal::Schema< GenericSchemaDocument >

Member Data Documentation

◆ allocator_

◆ kInitialSchemaMapSize

◆ kInitialSchemaRefSize

◆ ownAllocator_

◆ remoteProvider_

◆ root_

◆ schemaMap_

◆ schemaRef_

◆ typeless_

◆ uri_