Package Parser APIs for C++

SchemaValidator Interface

Table 18-7 summarizes the methods of available through the SchemaValidator interface.

Table 18-7 Summary of SchemaValidator Methods; Parser Package

Function	Summary
getSchemaList	Return the Schema list.
getValidatorId	Get validator identifier.
loadSchema	Load a schema document.
unloadSchema	Unload a schema document.

getSchemaList

Return only the size of loaded schema list documents if "list" is NULL. If "list" is not NULL, a list of URL pointers is returned in the user-provided pointer buffer. Note that its user's responsibility to provide a buffer with big enough size.

Syntax

virtual ub4 getSchemaList(
   oratext **list) const = 0;

Parameter	Description
list	address of a pointer buffer

Returns

(ub4) list size and list of loaded schemas (I/O parameter)

getValidatorId

Get the validator identifier corresponding to the implementation of this validator object.

Syntax

virtual SchValidatorIdType getValidatorId() const = 0;

Returns

(SchValidatorIdType) validator identifier

loadSchema

Load up a schema document to be used in the next validation session. Throws an exception in the case of an error.

Syntax

virtual void loadSchema( 
   oratext* schema_URI)
throw (ParserException) = 0;

Parameter	Description
schema_URI	URL of a schema document; compiler encoding

unloadSchema

Unload a schema document and all its descendants (included or imported in a nested manner from the validator. All previously loaded schema documents will remain loaded until they are unloaded. To unload all loaded schema documents, set schema_URI to be NULL. Throws an exception in the case of an error.

Syntax

virtual void unloadSchema(
   oratext* schema_URI)
throw (ParserException) = 0;

Parameter	Description
schema_URI	URL of a schema document; compiler encoding