GenericSchemaDocument< ValueT, Allocator > Class Template Reference

JSON schema document. More...

Classes
struct	SchemaEntry
struct	SchemaRefEntry

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

Public Member Functions
	GenericSchemaDocument (const ValueType &document, IRemoteSchemaDocumentProviderType *remoteProvider=0, Allocator *allocator=0)
	Constructor.
	~GenericSchemaDocument ()
	Destructor.
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

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

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

Friends
class	internal::Schema< GenericSchemaDocument >
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

template<typename ValueT , typename Allocator = CrtAllocator>

typedef ValueT GenericSchemaDocument< ValueT, Allocator >::ValueType

template<typename ValueT , typename Allocator = CrtAllocator>

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

template<typename ValueT , typename Allocator = CrtAllocator>

typedef Allocator GenericSchemaDocument< ValueT, Allocator >::AllocatorType

template<typename ValueT , typename Allocator = CrtAllocator>

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

template<typename ValueT , typename Allocator = CrtAllocator>

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

template<typename ValueT , typename Allocator = CrtAllocator>

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

template<typename ValueT , typename Allocator = CrtAllocator>

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

Constructor & Destructor Documentation

template<typename ValueT , typename Allocator = CrtAllocator>

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

inlineexplicit

Constructor.

Compile a JSON document into schema document.

Parameters

document	A JSON document as source.
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.

References GenericSchemaDocument< ValueT, Allocator >::allocator_, GenericSchemaDocument< ValueT, Allocator >::CreateSchemaRecursive(), GenericSchemaDocument< ValueT, Allocator >::GetSchema(), GenericSchemaDocument< ValueT, Allocator >::ownAllocator_, RAPIDJSON_ASSERT, RAPIDJSON_NEW, GenericSchemaDocument< ValueT, Allocator >::root_, GenericSchemaDocument< ValueT, Allocator >::SchemaRefEntry::schema, GenericSchemaDocument< ValueT, Allocator >::schemaMap_, GenericSchemaDocument< ValueT, Allocator >::schemaRef_, GenericSchemaDocument< ValueT, Allocator >::SchemaRefEntry::source, and GenericSchemaDocument< ValueT, Allocator >::SchemaRefEntry::target.

template<typename ValueT , typename Allocator = CrtAllocator>

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

inline

Destructor.

References GenericSchemaDocument< ValueT, Allocator >::ownAllocator_, RAPIDJSON_DELETE, and GenericSchemaDocument< ValueT, Allocator >::schemaMap_.

template<typename ValueT , typename Allocator = CrtAllocator>

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

private

Prohibit copying.

Member Function Documentation

template<typename ValueT , typename Allocator = CrtAllocator>

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

inline

Get the root schema.

References GenericSchemaDocument< ValueT, Allocator >::root_.

template<typename ValueT , typename Allocator = CrtAllocator>

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

private

Prohibit assignment.

template<typename ValueT , typename Allocator = CrtAllocator>

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

inlineprivate

References GenericSchemaDocument< ValueT, Allocator >::allocator_, GenericSchemaDocument< ValueT, Allocator >::CreateSchema(), GenericSchemaDocument< ValueT, Allocator >::GetSchema(), internal::Schema< SchemaDocumentType >::GetTypeless(), kArrayType, kObjectType, and SizeType.

Referenced by GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument().

template<typename ValueT , typename Allocator = CrtAllocator>

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

inlineprivate

References GenericSchemaDocument< ValueT, Allocator >::allocator_, GenericSchemaDocument< ValueT, Allocator >::HandleRefSchema(), RAPIDJSON_ASSERT, and GenericSchemaDocument< ValueT, Allocator >::schemaMap_.

Referenced by GenericSchemaDocument< ValueT, Allocator >::CreateSchemaRecursive().

template<typename ValueT , typename Allocator = CrtAllocator>

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

inlineprivate

References GenericSchemaDocument< ValueT, Allocator >::allocator_, IGenericRemoteSchemaDocumentProvider< SchemaDocumentType >::GetRemoteDocument(), GenericSchemaDocument< ValueT, Allocator >::remoteProvider_, GenericSchemaDocument< ValueT, Allocator >::schemaRef_, and SizeType.

Referenced by GenericSchemaDocument< ValueT, Allocator >::CreateSchema().

template<typename ValueT , typename Allocator = CrtAllocator>

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

inlineprivate

References GenericSchemaDocument< ValueT, Allocator >::schemaMap_.

Referenced by GenericSchemaDocument< ValueT, Allocator >::CreateSchemaRecursive(), and GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument().

template<typename ValueT , typename Allocator = CrtAllocator>

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

inlineprivate

References GenericSchemaDocument< ValueT, Allocator >::schemaMap_.

Friends And Related Function Documentation

template<typename ValueT , typename Allocator = CrtAllocator>

friend class internal::Schema< GenericSchemaDocument >

friend

template<typename ValueT , typename Allocator = CrtAllocator>

friend class GenericSchemaValidator

friend

Member Data Documentation

template<typename ValueT , typename Allocator = CrtAllocator>

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

staticprivate

template<typename ValueT , typename Allocator = CrtAllocator>

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

staticprivate

template<typename ValueT , typename Allocator = CrtAllocator>

IRemoteSchemaDocumentProviderType* GenericSchemaDocument< ValueT, Allocator >::remoteProvider_

private

Referenced by GenericSchemaDocument< ValueT, Allocator >::HandleRefSchema().

template<typename ValueT , typename Allocator = CrtAllocator>

Allocator* GenericSchemaDocument< ValueT, Allocator >::allocator_

private

Referenced by GenericSchemaDocument< ValueT, Allocator >::CreateSchema(), GenericSchemaDocument< ValueT, Allocator >::CreateSchemaRecursive(), GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument(), and GenericSchemaDocument< ValueT, Allocator >::HandleRefSchema().

template<typename ValueT , typename Allocator = CrtAllocator>

Allocator* GenericSchemaDocument< ValueT, Allocator >::ownAllocator_

private

Referenced by GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument(), and GenericSchemaDocument< ValueT, Allocator >::~GenericSchemaDocument().

template<typename ValueT , typename Allocator = CrtAllocator>

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

private

Root schema.

Referenced by GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument(), and GenericSchemaDocument< ValueT, Allocator >::GetRoot().

template<typename ValueT , typename Allocator = CrtAllocator>

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

private

Referenced by GenericSchemaDocument< ValueT, Allocator >::CreateSchema(), GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument(), GenericSchemaDocument< ValueT, Allocator >::GetPointer(), GenericSchemaDocument< ValueT, Allocator >::GetSchema(), and GenericSchemaDocument< ValueT, Allocator >::~GenericSchemaDocument().

template<typename ValueT , typename Allocator = CrtAllocator>

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

private

Referenced by GenericSchemaDocument< ValueT, Allocator >::GenericSchemaDocument(), and GenericSchemaDocument< ValueT, Allocator >::HandleRefSchema().

---

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

• schema.h