7 Package Tools APIs for C++

Tools packages contains types and interfaces related to the creation and instantiation of Oracle XML tools.

This chapter contains this section:

Tools Datatypes
Factory Interface
FactoryException Interface

Tools Datatypes

Table 7-1 summarizes the datatypes of the Tools package.

CPXML2953 Table 7-1 Summary of Datatypes; Tools Package

Datatype	Description
FactoryExceptionCode	Tool Factory exceptions.

CPXML2954

FactoryExceptionCode

Tool Factory exceptions.

CPXML2955Definition

typedef enum FactoryExceptionCode {
   FACTORY_UNDEFINED_ERR = 0,
   FACTORY_OTHER_ERR = 1 
} FactoryExceptionCode;

CPXML01710

Factory Interface

Table 7-2 summarizes the methods available through the Factory interface.

CPXML2956 Table 7-2 Summary of Factory Methods; Tools Package

Function	Summary
Factory()	Constructor.
createDOMParser()	Create DOM Parser.
createSAXParser()	Create SAX Parser.
createSchemaValidator()	Create schema validator.
createXPathCompProcessor()	Create extended XPath processor.
createXPathCompiler()	Create XPath compiler.
createXPathProcessor()	Create XPath processor.
createXPointerProcessor()	Create XPointer processor.
createXslCompiler()	Create Xsl compiler.
createXslExtendedTransformer()	Create XSL extended transformer.
createXslTransformer()	Create XSL transformer.
getContext()	Get factory's context.
~Factory()	Default destructor.

CPXML2957

Factory()

Class constructor.

Syntax	Description
Factory() throw (FactoryException);	Default constructor
Factory( Context* ctx_ptr) throw (FactoryException);	Creates factory object given a Context object.

Parameter	Description
ctx_ptr	pointer to a context object

CPXML2958Returns

(Factory) object

CPXML2959

createDOMParser()

Creates DOM parser.

CPXML2960Syntax

DOMParser< Context, Node>* createDOMParser (
   DOMParserIdType id_type, 
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	parser id type
ctx_ptr	pointer to a Context object

CPXML2961Returns

(DOMParser*) pointer to the parser object

CPXML2962

createSAXParser()

Creates SAX parser.

CPXML2963Syntax

SAXParser< Context>* createSAXParser (
   SAXParserIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	parser id type
ctx_ptr	pointer to a Context object

CPXML2964Returns

(SAXParser*) pointer to the parser object

CPXML2965

createSchemaValidator()

Creates schema validator.

CPXML2966Syntax

SchemaValidator< Node>* createSchemaValidator (
   SchValidatorIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	validator id type
ctx_ptr	pointer to a Context object

CPXML2967Returns

(SchemaValidator*) pointer to the validator object

CPXML2968

createXPathCompProcessor()

Creates extended XPath processor; takes XvmPrCXml value only.

CPXML2969Syntax

CompProcessor< Context, Node>* createXPathCompProcessor (
   XPathPrIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	processor id type
ctx_ptr	pointer to a Context object

CPXML2970Returns

(CompProcessor*) pointer to the processor object

CPXML2971

createXPathCompiler()

Creates XPath compiler.

CPXML2972Syntax

XPath::Compiler< Context, Node>* createXPathCompiler (
   XPathCompIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	compiler id type
ctx_ptr	pointer to a Context object

CPXML2973Returns

(XPathCompiler*) pointer to the compiler object

CPXML2974

createXPathProcessor()

Creates XPath processor.

CPXML2975Syntax

XPath::Processor< Context, Node>* createXPathProcessor (
   XPathPrIdType id_type, 
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	processor id type
ctx_ptr	pointer to a Context object

CPXML2976Returns

(Processor*) pointer to the processor object

CPXML2977

createXPointerProcessor()

Creates XPointer processor.

CPXML2978Syntax

XPointer::Processor< Context, Node>* createXPointerProcessor (
   XppPrIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	processor id type
ctx_ptr	pointer to a Context object

CPXML2979Returns

(Processor*) pointer to the processor object

CPXML2980

createXslCompiler()

Creates Xsl compiler.

CPXML2981Syntax

Xsl::Compiler< Context, Node>* createXslCompiler (
   XslCompIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	compiler id type
ctx_ptr	pointer to a Context object

CPXML2982Returns

(Compiler*) pointer to the compiler object

CPXML2983

createXslExtendedTransformer()

Creates XSL extended trnasformer; takes XvmTrCXml value only.

CPXML2984Syntax

CompTransformer< Context, Node>* createXslExtendedTransformer (
   XslTrIdType id_type,
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	transformer id type
ctx_ptr	pointer to a Context object

CPXML2985Returns

(CompTrasformer*) pointer to the transformer object

CPXML2986

createXslTransformer()

Creates XSL trnasformer.

CPXML2987Syntax

Transformer< Context, Node>* createXslTransformer (
   XslTrIdType id_type, 
   Context* ctx_ptr = NULL)
throw (FactoryException);

Parameter	Description
id_type	transformer id type
ctx_ptr	pointer to a Context object

CPXML2988Returns

(Trasformer*) pointer to the transformer object

CPXML2989

getContext()

Returns factory's context.

CPXML2990Syntax

Context* getContext() const;

CPXML2991Returns

(Context*) pointer to the context object

CPXML2992

~Factory()

Default destructor.

CPXML2993Syntax

~Factory();

CPXML01720

FactoryException Interface

Table 7-3 summarizes the methods available through the FactoryException interface.

CPXML2994 Table 7-3 Summary of FactoryException Methods; Tools Package

Function	Summary
getCode()	Get Oracle XML error code embedded in the exception.
getFactoryCode()	Get FactoryException code embedded in the exception.
getMesLang()	Get current language (encoding) of error messages.
getMessage()	Get Oracle XML error message.

CPXML2995

getCode()

Gets Oracle XML error code embedded in the exception. Virtual member function inherited from XmlException.

CPXML2996Syntax

virtual unsigned getCode() const = 0;

CPXML2997Returns

(unsigned) numeric error code (0 on success)

CPXML2998

getFactoryCode()

This is a virtual member function that defines a prototype for implementation defined member functions returning exception codes specific to the Tools namespace, defined in FactoryExceptionCode, of the exceptional situations during execution

CPXML2999Syntax

virtual FactoryExceptionCode getFactoryCode() const = 0;

CPXML3000Returns

(FactoryExceptionCode) exception code

CPXML3001

getMesLang()

Virtual member function inherited from XmlException.

CPXML3002Syntax

virtual oratext* getMesLang() const = 0;

CPXML3003Returns

(oratext*) Current language (encoding) of error messages

CPXML3004

getMessage()

Virtual member function inherited from XmlException.

CPXML3005Syntax

virtual oratext* getMessage() const = 0;

CPXML3006Returns

(oratext *) Error message