Public Member Functions

base_soap::SOAPMemFileInputSource Class Reference

An input source for the xercesc parser that takes the xml document from a memory buffer or file. More...

#include <libppbase/base_soap/SOAPMemFileInputSource.h>

List of all members.

Public Member Functions

 SOAPMemFileInputSource (base::MemFile *source, bool own)
 Constructor.
 ~SOAPMemFileInputSource ()
 Destructor.
const XMLCh * getBaseURI () const
 Get the base URI to be used for resolving relative URIs to absolute URIs.
const XMLCh * getEncoding () const
 An input source can be set to force the parser to assume a particular encoding for the data that input source reprsents, via the setEncoding() method.
bool getIssueFatalErrorIfNotFound () const
 Get the flag that indicates if the parser should issue fatal error if this input source is not found.
const XMLCh * getPublicId () const
 Get the public identifier for this input source.
const XMLCh * getSystemId () const
 Get the system identifier for this input source.
xercesc::BinInputStream * makeStream () const
 Makes the byte stream for this input source.
void release ()
 Called to indicate that this DOMInputSource is no longer in use and that the implementation may relinquish any resources associated with it.
void setBaseURI (const XMLCh *const baseURI)
 Set the base URI to be used for resolving relative URIs to absolute URIs.
void setEncoding (const XMLCh *const encodingStr)
 Set the encoding which will be required for use with the XML text read via a stream opened by this input source.
void setIssueFatalErrorIfNotFound (const bool flag)
 Indicates if the parser should issue fatal error if this input source is not found.
void setPublicId (const XMLCh *const publicId)
 Set the public identifier for this input source.
void setSystemId (const XMLCh *const systemId)
 Set the system identifier for this input source.

Detailed Description

An input source for the xercesc parser that takes the xml document from a memory buffer or file.

Author:
Christoph Schwarz
Version:
Id:
SOAPMemFileInputSource.h 21 2010-09-05 04:18:17Z cschwarz1

Constructor & Destructor Documentation

base_soap::SOAPMemFileInputSource::SOAPMemFileInputSource ( base::MemFile source,
bool  own 
)

Constructor.

Parameters:
source the source memory file
own flag: take ownership of this mem file

Member Function Documentation

const XMLCh* base_soap::SOAPMemFileInputSource::getBaseURI (  )  const

Get the base URI to be used for resolving relative URIs to absolute URIs.

If the baseURI is itself a relative URI, the behavior is implementation dependent

Returns:
The base URI
const XMLCh* base_soap::SOAPMemFileInputSource::getEncoding (  )  const

An input source can be set to force the parser to assume a particular encoding for the data that input source reprsents, via the setEncoding() method.

This method returns name of the encoding that is to be forced. If the encoding has never been forced, it returns a null pointer

Returns:
The forced encoding, or null if none was supplied
bool base_soap::SOAPMemFileInputSource::getIssueFatalErrorIfNotFound (  )  const

Get the flag that indicates if the parser should issue fatal error if this input source is not found.

True if the parser should issue fatal error if this input source is not found. False if the parser issue warning message instead

const XMLCh* base_soap::SOAPMemFileInputSource::getPublicId (  )  const

Get the public identifier for this input source.

Returns:
The public identifier, or null if none was supplied
const XMLCh* base_soap::SOAPMemFileInputSource::getSystemId (  )  const

Get the system identifier for this input source.

If the system ID is a URL, it will be fully resolved

Returns:
The system identifier
xercesc::BinInputStream* base_soap::SOAPMemFileInputSource::makeStream (  )  const

Makes the byte stream for this input source.

The derived class must create and return a binary input stream of an appropriate type for its kind of data source. The returned stream must be dynamically allocated and becomes the parser's property

Returns:
The byte stream
void base_soap::SOAPMemFileInputSource::release (  ) 

Called to indicate that this DOMInputSource is no longer in use and that the implementation may relinquish any resources associated with it.

Access to a released object will lead to unexpected result

void base_soap::SOAPMemFileInputSource::setBaseURI ( const XMLCh *const   baseURI  ) 

Set the base URI to be used for resolving relative URIs to absolute URIs.

If the baseURI is itself a relative URI, the behavior is implementation dependent

Parameters:
baseURI The base URI
void base_soap::SOAPMemFileInputSource::setEncoding ( const XMLCh *const   encodingStr  ) 

Set the encoding which will be required for use with the XML text read via a stream opened by this input source.

This is usually not set, allowing the encoding to be sensed in the usual XML way. However, in some cases, the encoding in the file is known to be incorrect because of intermediate transcoding, for instance encapsulation within a MIME document

Parameters:
encodingStr The name of the encoding to force
void base_soap::SOAPMemFileInputSource::setIssueFatalErrorIfNotFound ( const bool  flag  ) 

Indicates if the parser should issue fatal error if this input source is not found.

If set to false, the parser issue warning message instead

Parameters:
flag True if the parser should issue fatal error if this input source is not found. If set to false, the parser issue warning message instead (default: true)
void base_soap::SOAPMemFileInputSource::setPublicId ( const XMLCh *const   publicId  ) 

Set the public identifier for this input source.

The public identifier is always optional: if the application writer includes one, it will be provided as part of the location information

Parameters:
publicId The public identifier as a string
void base_soap::SOAPMemFileInputSource::setSystemId ( const XMLCh *const   systemId  ) 

Set the system identifier for this input source.

The system id is always required. The public id may be used to map to another system id, but the system id must always be present as a fallback. If the system ID is a URL, it must be fully resolved

Parameters:
systemId The system identifier as a string

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