GenericSchemaDocument< ValueT, Allocator > Class Template Reference

JSON schema document. More...

#include <fwd.h>

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, AllocatorType >	SValue
typedef GenericUri< ValueType, Allocator >	UriType

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

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

SValue

template<typename ValueT , typename Allocator = CrtAllocator>

typedef GenericValue<EncodingType, AllocatorType> GenericSchemaDocument< ValueT, Allocator >::SValue

UriType

template<typename ValueT , typename Allocator = CrtAllocator>

typedef GenericUri<ValueType, Allocator> GenericSchemaDocument< ValueT, Allocator >::UriType

ValueType

template<typename ValueT , typename Allocator = CrtAllocator>

typedef ValueT GenericSchemaDocument< ValueT, Allocator >::ValueType

Constructor & Destructor Documentation

GenericSchemaDocument()

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, const PointerType &  pointer = PointerType()  )

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.
pointer	An optional JSON pointer to the start of the schema document

~GenericSchemaDocument()

template<typename ValueT , typename Allocator = CrtAllocator>

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

inline

Destructor.

Here is the call graph for this function:

Member Function Documentation

GetRoot()

template<typename ValueT , typename Allocator = CrtAllocator>

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

inline

Get the root schema.

GetURI()

template<typename ValueT , typename Allocator = CrtAllocator>

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

inline

Friends And Related Function Documentation

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

---

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

• blam/components/3rdparty/rapidjson/fwd.h
• blam/components/3rdparty/rapidjson/schema.h