Lima::DocumentsReader Namespace Reference

Classes
class	AbstractDocumentElement
class	AbstractReaderResource
class	AbstractStructuredDocumentElement
	Element avec contenu texte. More...
class	AbstractStructuredDocumentElementWithProperties
class	ContentElementPart
	Partie de texte (contenu dans un element) partageant le meme offset caractere. More...
class	ContentStructuredDocument
	Partie d'un document structure decodee avant analyse. More...
class	DiscardableDocumentElement
	Element d'un document Xml discardable Exemple <USELESS>private comment</USELESS> => " ". More...
class	DocumentPropertyElement
	Element d'un document XML definissant une propriete du noeud pere Exemple <filename>d1.xml</filename> la valeur sera convertie en valeur de propriete et affectee a l'element pere selon m_propType. More...
class	DocumentPropertyType
class	DocumentPropertyTypePrivate
class	DocumentReader
	read a XML document More...
class	DocumentReaderException
class	DocumentReaderPrivate
class	DocumentsReaderResources
	singleton that holds all resources about documents reader More...
class	ExtensionDocumentPropertyType
class	FieldTypeElement
class	HierarchyDocumentElement
	A hierarchy node. More...
class	IgnoredDocumentElement
	An ignored node. More...
class	IndexingDocumentElement
	Element d'un document XML dont content est indexee Exemple <section lang="fre">yeah</section> Il peut avoir des fils On peut lui affecter des proprietes: addProperty() Il peut etre un element d'indexation: isIndexing() Il a une liste de proprietes à propager Lui ou un parent est une unite d'indexation : isLocated() A la limite, il peut etre une propriete, mais c'est un cas exceptionel de (con)fusion entre contenu, propriete et element indexe exemple <doc><title>titre</title><content>bla bla</content><doc> le doc n'est pas de type indexing mais le titre l'est et est une propriete de doc auquel cas, il n'y a pas de proprietes a propager ?? Il herite de hasContent() More...
class	PresentationDocumentElement
	Element d'un document XML de presentation Exemple <BOLD>important</BOLD> => " important " ou bien <BOLD>C'est <UNDERLINED>tres<UNDERLINED>important</BOLD> => " C'est tres< important ". More...
class	PropagatedProperties
struct	ReaderResourceInitializationParameters
	like linguistic resource abstraction. More...
class	StandardDocumentPropertyType
class	StructuredDocumentXMLParser
	XML parser for source structured documents. More...
class	TokensStream
	This is a stream of tokens. More...

Enumerations
enum	FieldType {   NODE_NOTYPE , NODE_ROOT , NODE_DISCARDABLE , NODE_INDEXING ,   NODE_HIERARCHY , NODE_PRESENTATION , NODE_IGNORED , NODE_PROPERTY }
	a type containing the type of an element More...
enum	StorageType {   STORAGE_NONE , STORAGE_UTF8_STRING , STORAGE_INTEGER , STORAGE_DATE ,   STORAGE_DATE_INTERVAL , STORAGE_WEIGHTED_PROPERTY }
	a type meaning the storage type of an attribute More...
enum	CardinalityType { CARDINALITY_NONE , CARDINALITY_OPTIONAL , CARDINALITY_MANDATORY , CARDINALITY_MULTIPLE }
	a type meaning the cardinality of an attribute More...

Functions
std::ostream &	operator<< (std::ostream &out, const PropagatedProperties &properties)
QTextStream &	operator<< (QTextStream &out, const PropagatedProperties &properties)
QDebug &	operator<< (QDebug &out, const PropagatedProperties &properties)

Variables
Lima::SimpleFactory< AbstractReaderResource, Lima::DocumentsReader::StandardDocumentPropertyType >	standardPropertyTypeFactory (STANDARDDOCUMENTPROPERTYTYPE_CLASSID)
Lima::SimpleFactory< AbstractReaderResource, Lima::DocumentsReader::ExtensionDocumentPropertyType >	extensionDocumentPropertyTypeFactory (EXTENSIONDOCUMENTPROPERTYTYPE_CLASSID)
static const QString	storageTypeTag [MAX_STORAGE_TYPE]
static const QString	cardinalityTypeTag [MAX_STORAGE_TYPE]
Lima::SimpleFactory< AbstractReaderResource, Lima::DocumentsReader::StructuredDocumentXMLParser >	structuredDocumentXMLParserFactory (STRUCTUREDDOCUMENTXMLPARSER_CLASSID)
static const QString	tagSemanticItem [MAX_NODE_TYPE]

Enumeration Type Documentation

CardinalityType

enum Lima::DocumentsReader::CardinalityType

a type meaning the cardinality of an attribute

Enumerator
CARDINALITY_NONE
CARDINALITY_OPTIONAL
CARDINALITY_MANDATORY
CARDINALITY_MULTIPLE

Definition at line 44 of file documentProperty.h.

FieldType

enum Lima::DocumentsReader::FieldType

a type containing the type of an element

Enumerator
NODE_NOTYPE
NODE_ROOT	no type: field is ignored
NODE_DISCARDABLE	root of XML file
NODE_INDEXING	node inside an indexing node whose content (including its children) is replaced by spaces
NODE_HIERARCHY	node whose content is analyzed and indexed
NODE_PRESENTATION	node that can contain indexing nodes in its hierarchy. It is indexed in the structure index
NODE_IGNORED	node inside an indexing node with content replaced by spaces, but which content is kept
NODE_PROPERTY	nodes which are not children of hierarchy nodes are ignored

Definition at line 33 of file DocumentElements.h.

StorageType

enum Lima::DocumentsReader::StorageType

a type meaning the storage type of an attribute

Enumerator
STORAGE_NONE
STORAGE_UTF8_STRING
STORAGE_INTEGER
STORAGE_DATE
STORAGE_DATE_INTERVAL
STORAGE_WEIGHTED_PROPERTY

Definition at line 24 of file documentProperty.h.

Function Documentation

operator<<() [1/3]

QDebug & Lima::DocumentsReader::operator<<	(	QDebug &	out,
		const PropagatedProperties &	properties
	)

Definition at line 119 of file DocumentElements.cpp.

operator<<() [2/3]

QTextStream & Lima::DocumentsReader::operator<<	(	QTextStream &	out,
		const PropagatedProperties &	properties
	)

Definition at line 113 of file DocumentElements.cpp.

operator<<() [3/3]

std::ostream & Lima::DocumentsReader::operator<<	(	std::ostream &	out,
		const PropagatedProperties &	properties
	)

Definition at line 107 of file DocumentElements.cpp.

Variable Documentation

cardinalityTypeTag

const QString Lima::DocumentsReader::cardinalityTypeTag[MAX_STORAGE_TYPE]

static

Initial value:

={
  "none",
  "optional",
  "mandatory",
  "multi-valued"
}

Definition at line 52 of file documentProperty.h.

extensionDocumentPropertyTypeFactory

Lima::SimpleFactory< AbstractReaderResource, Lima::DocumentsReader::ExtensionDocumentPropertyType > Lima::DocumentsReader::extensionDocumentPropertyTypeFactory(EXTENSIONDOCUMENTPROPERTYTYPE_CLASSID)

(

EXTENSIONDOCUMENTPROPERTYTYPE_CLASSID

)

standardPropertyTypeFactory

Lima::SimpleFactory< AbstractReaderResource, Lima::DocumentsReader::StandardDocumentPropertyType > Lima::DocumentsReader::standardPropertyTypeFactory(STANDARDDOCUMENTPROPERTYTYPE_CLASSID)

(

STANDARDDOCUMENTPROPERTYTYPE_CLASSID

)

storageTypeTag

const QString Lima::DocumentsReader::storageTypeTag[MAX_STORAGE_TYPE]

static

Initial value:

={
  "none",
  "string",
  "integer",
  "date",
  "date_interval",
  "weighted_property"
}

Definition at line 34 of file documentProperty.h.

structuredDocumentXMLParserFactory

Lima::SimpleFactory< AbstractReaderResource, Lima::DocumentsReader::StructuredDocumentXMLParser > Lima::DocumentsReader::structuredDocumentXMLParserFactory(STRUCTUREDDOCUMENTXMLPARSER_CLASSID)

(

STRUCTUREDDOCUMENTXMLPARSER_CLASSID

)

tagSemanticItem

const QString Lima::DocumentsReader::tagSemanticItem[MAX_NODE_TYPE]

static

Initial value:

=
{
    "",
    "rootNodes",
    "discardableNodes",
    "indexingNodes",
    "hierarchyNodes",
    "presentationNodes",
    "ignoredNodes",
    "propertyNodes"
}

Definition at line 33 of file structuredDocumentXMLParser.h.