 |
SaxonC 13.0.0
Saxon Processor library for C/C++, PHP and Python
|
Loading...
Searching...
No Matches
|
SaxonC 13.0.0
Saxon Processor library for C/C++, PHP and Python
|
#include <SchemaValidator.h>
Public Member Functions | |
| SchemaValidator () | |
| Default constructor. | |
| SchemaValidator (SaxonProcessor *proc, std::string cwd="") | |
| Constructor with the SaxonProcessor supplied. | |
| SchemaValidator (const SchemaValidator &other) | |
| SchemaValidator copy constructor. | |
| ~SchemaValidator () | |
| Destructor method to clean up memory held by the SchemaValidator. | |
| SchemaValidator & | operator= (const SchemaValidator &other) |
| The copy assignment= operator. | |
| void | setcwd (const char *cwd) |
| Set the current working directory for the validator. | |
| const char * | getcwd () |
| Get the current working directory set on this validator. | |
| void | registerSchemaFromFile (const char *xsd) |
| Register the schema from file name. | |
| void | registerSchemaFromString (const char *schemaStr, const char *systemID=nullptr) |
| Register the schema supplied as a string. | |
| void | registerSchemaFromNode (XdmNode *node) |
| Register the schema supplied as an XDM Node Object. | |
| void | exportSchema (const char *fileName) |
| Export a precompiled Schema Component Model. | |
| void | setOutputFile (const char *outputFile) |
| Set the name of the output file that will be used by the validator. | |
| const char * | getOutputFile () |
| Get the output file that will be used by the validator. | |
| void | validate (const char *sourceFile=nullptr) |
| Validate an instance document by a registered schema. | |
| void | validateFromString (const char *content) |
| Validate an instance document by a registered schema. | |
| XdmNode * | validateToNode (const char *sourceFile=nullptr) |
| Validate an instance document supplied as a Source object. | |
| void | setSourceNode (XdmNode *source) |
| Set the source node for validation. | |
| XdmNode * | getValidationReport () |
| Get the validation report. | |
| void | setParameter (const char *name, XdmValue *value, bool withParam=true) |
| Set the value of a parameter used in the validator. | |
| bool | removeParameter (const char *name) |
| Remove a parameter (name, value) pair. | |
| void | setProperty (const char *name, const char *value) |
| Set a configuration property specific to the validator in use. | |
| void | clearParameters (bool deleteValues=false) |
| Clear parameter values set. | |
| void | clearProperties () |
| Clear configuration property values set. | |
| XdmValue * | getParameter (const char *name, bool withParam=true) |
| Get the value of a parameter. | |
| std::map< std::string, XdmValue * > & | getParameters () |
| Get all parameters as a std::map. | |
| std::map< std::string, std::string > & | getProperties () |
| Get all configuration properties specified on the processor as a std::map. | |
| void | setLax (bool l) |
| Set the validation mode - which may be either strict or lax. | |
| bool | isLax () |
| Ask whether validation is to be in lax mode. | |
| XsdSchema * | getSchema () |
| Get the schema used by this schema validator. | |
| void | setUseXsiSchemaLocation (bool recognize) |
| bool | isUseXsiSchemaLocation () |
| void | setDocumentElementName (const char *eqname) |
| const char * | getDocumentElementName () |
| void | validateMultiple (const char **sourceFile) |
| bool | isExpandAttributeDefaults () |
| void | setExpandAttributeDefaults (bool expand) |
| int64_t | getUnderlyingValidator () |
| Get the underlying Java object of the C++ schema validator. | |
| SaxonProcessor * | getSaxonProcessor () |
| Get the SaxonProcessor which created this SchemaValidator. | |
Friends | |
| class | XsdSchema |
| class | DocumentBuilder |
A SchemaValidator represents a factory for validating instance documents against a schema.
| SchemaValidator::SchemaValidator | ( | ) |
Default constructor.
Creates a Schema Validator
| SaxonApiException |
| SchemaValidator::SchemaValidator | ( | SaxonProcessor * | proc, |
| std::string | cwd = "" ) |
Constructor with the SaxonProcessor supplied.
The supplied processor should have license flag set to true for the Schema Validator to operate.
| proc | - pointer to the SaxonProcessor object |
| cwd | - the current working directory |
| SaxonApiException |
| SchemaValidator::SchemaValidator | ( | const SchemaValidator & | other | ) |
SchemaValidator copy constructor.
| other | - SchemaValidator |
| void SchemaValidator::clearParameters | ( | bool | deleteValues = false | ) |
Clear parameter values set.
Default behaviour (false) is to leave XdmValues in memory. Individual pointers to XdmValue objects have to be deleted in the calling program.
| deleteValues | - if true then XdmValues are deleted |
| void SchemaValidator::exportSchema | ( | const char * | fileName | ) |
Export a precompiled Schema Component Model.
The Component model containing all the components (except built-in components) that have been loaded by using the register methods.
| fileName | - The file name where the exported schema will be stored |
| SaxonApiException |
| const char * SchemaValidator::getcwd | ( | ) |
Get the current working directory set on this validator.
Memory deallocation is handled internally.
| const char * SchemaValidator::getOutputFile | ( | ) |
Get the output file that will be used by the validator.
| XdmValue * SchemaValidator::getParameter | ( | const char * | name, |
| bool | withParam = true ) |
Get the value of a parameter.
| name | - the name of the parameter |
| withParam | - internal use only |
| XsdSchema * SchemaValidator::getSchema | ( | ) |
Get the schema used by this schema validator.
| XdmNode * SchemaValidator::getValidationReport | ( | ) |
Get the validation report.
The 'report-node' option must have been set to true in the properties to use this feature: e.g. using setProperty("report-node", true) on the class object.
| SaxonApiException |
| bool SchemaValidator::isLax | ( | ) |
Ask whether validation is to be in lax mode.
| SchemaValidator & SchemaValidator::operator= | ( | const SchemaValidator & | other | ) |
The copy assignment= operator.
Create a copy of the SchemaValidator.
| other | - SchemaValidator object |
| void SchemaValidator::registerSchemaFromFile | ( | const char * | xsd | ) |
Register the schema from file name.
The schema components derived from this schema document are added to the cache of schema components maintained by this SchemaValidator.
| xsd | - File name of the schema relative to the cwd or full path if cwd is null. The document may be either a schema document in source XSD format, or a compiled schema in Saxon-defined SCM format (as produced using the method exportSchema) |
| SaxonApiException |
| void SchemaValidator::registerSchemaFromNode | ( | XdmNode * | node | ) |
Register the schema supplied as an XDM Node Object.
| node | - The schema document supplied as an XdmNode object |
| SaxonApiException |
| void SchemaValidator::registerSchemaFromString | ( | const char * | schemaStr, |
| const char * | systemID = nullptr ) |
Register the schema supplied as a string.
| schemaStr | - The schema document supplied as a string |
| systemID | - The system ID of the document supplied as a string |
| SaxonApiException |
| bool SchemaValidator::removeParameter | ( | const char * | name | ) |
Remove a parameter (name, value) pair.
| name | - the name of the parameter |
| void SchemaValidator::setcwd | ( | const char * | cwd | ) |
Set the current working directory for the validator.
| cwd | - Supplied working directory which replaces any set cwd. Ignore if cwd is NULL. |
| void SchemaValidator::setLax | ( | bool | l | ) |
Set the validation mode - which may be either strict or lax.
The default is strict; this method may be called to indicate that lax validation is required. With strict validation, validation fails if no element declaration can be located for the outermost element. With lax validation, the absence of an element declaration results in the content being considered valid.
| l | - true if validation is to be lax, false if it is to be strict |
| void SchemaValidator::setOutputFile | ( | const char * | outputFile | ) |
Set the name of the output file that will be used by the validator.
| outputFile | the output file name for later use |
| void SchemaValidator::setParameter | ( | const char * | name, |
| XdmValue * | value, | ||
| bool | withParam = true ) |
Set the value of a parameter used in the validator.
| name | - the name of the parameter, as a string. For a namespaced name use clark notation i.e. "{uri}local" |
| value | - the value of the parameter, or nullptr to clear a previously set value |
| void SchemaValidator::setProperty | ( | const char * | name, |
| const char * | value ) |
Set a configuration property specific to the validator in use.
| name | - the name of the property |
| value | - the value of the property |
| void SchemaValidator::setSourceNode | ( | XdmNode * | source | ) |
Set the source node for validation.
| source | - The source document supplied as an XdmNode, which will be used to validate against the schema using the validate methods. The caller is responsible for deallocation of memory associated with the source node. |
| void SchemaValidator::validate | ( | const char * | sourceFile = nullptr | ) |
Validate an instance document by a registered schema.
| sourceFile | Name of the file to be validated. Allow nullptr when source document is supplied with other method |
| SaxonApiException |
| void SchemaValidator::validateFromString | ( | const char * | content | ) |
Validate an instance document by a registered schema.
| sourceFile | Name of the file to be validated. Allow nullptr when source document is supplied with other method |
| SaxonApiException |
| XdmNode * SchemaValidator::validateToNode | ( | const char * | sourceFile = nullptr | ) |
Validate an instance document supplied as a Source object.
| sourceFile | The name of the file to be validated. Default is nullptr |
| SaxonApiException |
1.17.0