Schema Interface

Table 7-1 summarizes the methods of available through the Schema interface.

XmlSchemaClean

Clean up loaded schemas in a schema context and recycle the schema context.

void XmlSchemaClean(
   xsdctx *sctx);

sctx

IN

XmlSchemaCreate

Return a schema context to be used in other validator APIs. This needs to be paired with an XmlSchemaDestroy.

xsdctx *XmlSchemaCreate(
   xmlctx *xctx, 
   xmlerr *err, 
list);

xctx

IN

err

OUT

list

IN

(xsdctx *) schema context

XmlSchemaDestroy

Destroy a schema context and free up all its resources.

void XmlSchemaDestroy(
   xsdctx *sctx);

sctx

IN

XmlSchemaErrorWhere

Returns the location (line#, path) where an error occurred.

xmlerr XmlSchemaErrorWhere(
   xsdctx *sctx, 
   ub4 *line, 
   oratext **path);

sctx

IN

line

IN/OUT

path

IN/OUT

(xmlerr) error code

XmlSchemaLoad

Load up a schema document to be used in the next validation session. Schema documents can be incrementally loaded into a schema context as long as every loaded schema document is valid. When the last loaded schema turns out to be invalid, you need to clean up the schema context by calling XmlSchemaClean and reload everything all over again including the last schema with appropriate correction.

xmlerr XmlSchemaLoad(
   xsdctx *sctx, 
   oratext *uri, 
list);

sxctx

IN

uri

IN

list

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlSchemaLoadedList

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

ub4 XmlSchemaLoadedList(
   xsdctx *sctx, 
   oratext **list);

sctx

IN

list

IN

(ub4) list size

XmlSchemaSetErrorHandler

Sets an error message handler and its associated context in a schema context. To retrieve useful location information on errors, the address of the schema context must be provided in the error handler context.

xmlerr XmlSchemaSetErrorHandler(
   xsdctx *sctx, 
   XML_ERRMSG_F(
      (*errhdl), 
      ectx, 
      msg, 
      err), 
   void *errctx);

sctx

IN

errhdl

IN

errctx

IN

(xmlerr) error code

XmlSchemaSetValidateOptions

Set options to be used in the next validation session. Previously set options will remain effective until they are overwritten or reset.

xmlerr XmlSchemaSetValidateOptions(
   xsdctx *sctx, 
list);

sctx

IN

list

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlSchemaTargetNamespace

Return target namespace of a given schema document identified by its URI. All currently loaded schema documents can be queried. Currently loaded schema documents include the ones loaded through XmlSchemaLoads and the ones loaded through schemaLocation or noNamespaceSchemaLocation hints.

oratext *XmlSchemaTargetNamespace(
   xsdctx *sctx, 
   oratext *uri);

sctx

IN

uri

IN

(oratext *) target namespace string; NULL if given document not

XmlSchemaUnload

Unload a schema document from the validator. All previously loaded schema documents will remain loaded until they are unloaded. To unload all loaded schema documents, set URI to be NULL (this is equivalent to XmlSchemaClean). Note that all children schemas associated with the given schema are also unloaded. In this implementation, it only support the following scenarios:

• load, load, ...

• load, load, load, unload, unload, unload, clean, and then repeat.

It doesn't not support: load, load, unload, load, ....

xmlerr XmlSchemaUnload(
   xsdctx *sctx, 
   oratext *uri, 
list);

sctx

IN

uri

IN

list

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlSchemaValidate

Validates an element node against a schema. Schemas used in current session consists of all schema documents specified through XmlSchemaLoad and provided as hint(s) through schemaLocation or noNamespaceSchemaLocation in the instance document. After the invocation of this routine, all loaded schema documents remain loaded and can be queried by XmlSchemaLoadedList. However, they will remain inactive. In the next validation session, inactive schema documents can be activated by specifying them through XmlSchemaLoad or providing them as hint(s) through schemaLocation or noNamespaceSchemaLocation in the new instance document. To unload a schema document and all its descendants (documents included or imported in a nested manner), use XmlSchemaUnload.

xmlerr XmlSchemaValidate(
   xsdctx *sctx,
   xmlctx *xctx, 
   xmlelemnode *elem);

sctx

IN

xctx

IN

elem

IN

(xmlerr) numeric error code, XMLERR_OK [0] on success

XmlSchemaVersion

Return the version of this schema implementation.

oratext *XmlSchemaVersion();

(oratext *) version string [compiler encoding]