read a XML document More...

#include <linguisticProcessing/core/DocumentsReader/documentReader.h>

Public Member Functions
	DocumentReader (Lima::Common::XMLConfigurationFiles::ModuleConfigurationStructure &conf)

virtual	~DocumentReader ()

void	setLinguisticXMLDocHandler (StructuredXmlDocumentHandler *handler)

bool	initFile (const QString &filename)
	initialize the reader with a file containing documents in XML format

bool	initWithString (const QString &text)

bool	readXMLDocument ()
	read the next element in the current file (initFile must have been

uint64_t	getCurrentOffsetFromXmlReader ()
	Returns the reader's current character offset, starting with 0.

void	setShiftFrom (std::shared_ptr< const ShiftFrom > shiftFrom)

Detailed Description

read a XML document

Definition at line 31 of file documentReader.h.

Constructor & Destructor Documentation

◆ DocumentReader()

Lima::DocumentsReader::DocumentReader::DocumentReader ( Lima::Common::XMLConfigurationFiles::ModuleConfigurationStructure & conf )

Definition at line 122 of file documentReader.cpp.

◆ ~DocumentReader()

Lima::DocumentsReader::DocumentReader::~DocumentReader ( )

virtual

Definition at line 130 of file documentReader.cpp.

Member Function Documentation

◆ getCurrentOffsetFromXmlReader()

uint64_t Lima::DocumentsReader::DocumentReader::getCurrentOffsetFromXmlReader ( )

Returns the reader's current character offset, starting with 0.

Definition at line 184 of file documentReader.cpp.

◆ initFile()

bool Lima::DocumentsReader::DocumentReader::initFile ( const QString & filename )

initialize the reader with a file containing documents in XML format

Parameters

filename name of the file

Returns: true if initalization succeeded

Definition at line 148 of file documentReader.cpp.

◆ initWithString()

bool Lima::DocumentsReader::DocumentReader::initWithString ( const QString & text )

Definition at line 165 of file documentReader.cpp.

◆ readXMLDocument()

bool Lima::DocumentsReader::DocumentReader::readXMLDocument ( )

read the next element in the current file (initFile must have been

called beforehand, to initialize current file)

Returns: true if parsing was successful and false otherwise

Definition at line 197 of file documentReader.cpp.

◆ setLinguisticXMLDocHandler()

void Lima::DocumentsReader::DocumentReader::setLinguisticXMLDocHandler ( StructuredXmlDocumentHandler * handler )

Definition at line 140 of file documentReader.cpp.

◆ setShiftFrom()

void Lima::DocumentsReader::DocumentReader::setShiftFrom ( std::shared_ptr< const ShiftFrom > shiftFrom )

Definition at line 135 of file documentReader.cpp.

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

lima_linguisticprocessing/src/linguisticProcessing/core/DocumentsReader/documentReader.h
lima_linguisticprocessing/src/linguisticProcessing/core/DocumentsReader/documentReader.cpp

Public Member Functions