class LocalFileInputSource : public InputSource

This class is a derivative of the standard InputSource class

Inheritance:


Public Methods

virtual BinInputStream* makeStream () const
This method will return a binary input stream derivative that will parse from the local file indicatedby the system id

Inherited from InputSource:

Public

protected Constructors and Destructor

InputSource()
Default constructor
InputSource(const XMLCh* const systemId)
Constructor with a system identifier as XMLCh type
InputSource( const XMLCh* const systemId, const XMLCh* const publicId )
Constructor with a system and public identifiers
InputSource(const char* const systemId)
Constructor witha system identifier as string
InputSource( const char* const systemId, const char* const publicId )
Constructor witha system and public identifiers

Destructor

virtual ~InputSource()
Destructor

Getter methods

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
const XMLCh* getPublicId() const
Get the public identifier for this input source
const XMLCh* getSystemId() const
Get the system identifier for this input source

Setter methods

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 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

Virtual input source interface

virtual BinInputStream* makeStream() const
Makes the byte stream for this input source

Documentation

This class is a derivative of the standard InputSource class. It provides for the parser access to data which is referenced via a local file path, as apposed to remote file or URL. This is the most efficacious mechanism by which local files can be parsed, since the parse knows that it refers to a local file and will make no other attempts to interpret the passed path. The path provided can either be a fully qualified path or a relative path. If relative, it will be completed either relative to a passed base path or relative to the current working directory of the process. As with all InputSource derivatives. The primary objective of an input source is to create an input stream via which the parser can spool in data from the referenced source.
LocalFileInputSource( const XMLCh* const basePath, const XMLCh* const relativePath )
A local file input source requires a path to the file to load. This can be provided either as a fully qualified path, a path relative to the current working directly, or a path relative to a provided base path. The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' setPublicId() method of course. This constructor takes an explicit base path and a possibly relative path. If the relative path is seen to be fully qualified, it is used as is. Otherwise, it is made relative to the passed base path.
Parameters:
basePath - The base path from which the passed relative path will be based, if the relative part is indeed relative.
relativePath - The relative part of the path. It can actually be fully qualified, in which case it is taken as is.

LocalFileInputSource( const XMLCh* const filePath )
This constructor takes a single parameter which is the fully qualified or relative path. If it is fully qualified, it is taken as is. If it is relative, then it is completed relative to the current working directory (or the equivalent on the local host machine.) The completed path will become the system id of this input source. The constructors don't take any public id for local files, but you still set them via the parent class' setPublicId() method of course.
Parameters:
filePath - The relative or fully qualified path.

virtual BinInputStream* makeStream() const
This method will return a binary input stream derivative that will parse from the local file indicatedby the system id.
Returns:
A dynamically allocated binary input stream derivative that can parse from the file indicated by the system id.


This class has no child classes.

alphabetic index hierarchy of classes


Xerces-C XML Parser for C++ Version 1.1
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.

generated by doc++