Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

indri::parse::FileClassEnvironmentFactory Class Reference

#include <FileClassEnvironmentFactory.hpp>

List of all members.

Public Member Functions

 ~FileClassEnvironmentFactory ()
FileClassEnvironmentget (const std::string &name)
 Make an instance of a named FileClassEnvironment. Caller is responsible for deleting the pointer.

FileClassEnvironmentFactory::SpecificationgetFileClassSpec (const std::string &name)
 Make an instance of a named Specification, suitable for modifying an existing FileClassEnvironment. Caller is responsible for deleting the pointer.

void addFileClass (const FileClassEnvironmentFactory::Specification &spec)
 Add parsing information for a file class.

void addFileClass (const std::string &name, const std::string &iterator, const std::string &parser, const std::string &tokenizer, const std::string &startDocTag, const std::string &endDocTag, const std::string &endMetadataTag, const std::vector< std::string > &include, const std::vector< std::string > &exclude, const std::vector< std::string > &index, const std::vector< std::string > &metadata, const std::map< indri::parse::ConflationPattern *, std::string > &conflations)
 Add parsing information for a file class.


Private Attributes

std::map< std::string, struct
FileClassEnvironmentFactory::Specification * > 
_userTable


Constructor & Destructor Documentation

indri::parse::FileClassEnvironmentFactory::~FileClassEnvironmentFactory  ) 
 


Member Function Documentation

void indri::parse::FileClassEnvironmentFactory::addFileClass const std::string &  name,
const std::string &  iterator,
const std::string &  parser,
const std::string &  tokenizer,
const std::string &  startDocTag,
const std::string &  endDocTag,
const std::string &  endMetadataTag,
const std::vector< std::string > &  include,
const std::vector< std::string > &  exclude,
const std::vector< std::string > &  index,
const std::vector< std::string > &  metadata,
const std::map< indri::parse::ConflationPattern *, std::string > &  conflations
 

Add parsing information for a file class.

Parameters:
name name of this file class, eg trecweb
iterator document iterator for this file class
parser document parser for this file class
tokenizer document tokenizer for this file class
startDocTag tag indicating start of a document
endDocTag tag indicating the end of a document
endMetadataTag tag indicating the end of the metadata fields
include default tags whose contents should be included in the index
exclude tags whose contents should be excluded from the index
index tags that should be forwarded to the index for tag extents
metadata tags whose contents should be indexed as metadata
conflations tags that should be conflated

void indri::parse::FileClassEnvironmentFactory::addFileClass const FileClassEnvironmentFactory::Specification spec  ) 
 

Add parsing information for a file class.

Parameters:
spec the specification for this FileClassEnvironment

indri::parse::FileClassEnvironment * indri::parse::FileClassEnvironmentFactory::get const std::string &  name  ) 
 

Make an instance of a named FileClassEnvironment. Caller is responsible for deleting the pointer.

Parameters:
name the name of the FileClassEnvironment
Returns:
an initialized instance of the named FileClassEnvironment, or NULL if the name is not found.

indri::parse::FileClassEnvironmentFactory::Specification * indri::parse::FileClassEnvironmentFactory::getFileClassSpec const std::string &  name  ) 
 

Make an instance of a named Specification, suitable for modifying an existing FileClassEnvironment. Caller is responsible for deleting the pointer.

Parameters:
name the name of the Specification
Returns:
an initialized instance of the named Specification, or NULL if the name is not found.


Member Data Documentation

std::map<std::string, struct FileClassEnvironmentFactory::Specification*> indri::parse::FileClassEnvironmentFactory::_userTable [private]
 


The documentation for this class was generated from the following files:
Generated on Tue Jun 15 11:03:03 2010 for Lemur by doxygen 1.3.4