BasisTechnology::RLP::Context Class Reference

The RLP Context class, which analyzes data using RLP processors. More...

#include <bt_rlp_managed.h>

List of all members.

Public Member Functions

virtual bool GetConsistentType ()=0
virtual cli::array
< NamedEntityData^ >^ 
GetNamedEntityResultData (bool StripAffixes)=0
virtual String^ GetProcessorReport ()=0
 Get a report of the processors defined in this context.
virtual String^ GetProperty (String^ property)=0
 Get a context property value.
virtual Object^ GetResultData (ResultType resultType, bool safeDataOnly)=0
 Retrieve the data for a particular entity after processing input.
virtual void ProcessBuffer (cli::array< System::Byte >^data, LanguageID language, String^ encoding, String^ mime_type)=0
 Read and process data from a byte[], with optionally specified Language.
virtual void ProcessBuffer (cli::array< System::Char >^data, LanguageID language)=0
 Read and process data from a char[], with optionally specified Language.
virtual void ProcessBuffer (String^ data, LanguageID language)=0
 Read and process data from a String, with optionally specified Language.
virtual void ProcessFile (String^ data_file_pathname, LanguageID language, String^ encoding, String^ mime_type)=0
 Read and process data from a file, with optionally specified Language, Encoding, and MIME type/charset.
virtual void SetConsistentType (bool flag)=0
virtual void SetProperty (String^ property, String^ value)=0
 Set a context property value.
virtual ~Context ()


Detailed Description

An RLP context is an object that processes input data and produces analyzed results. The input data can be bytes in memory, String data in memory, or a file. The results are stored in memory. For accessing the results, see BasisTechnology::RLP::Context::GetResultData

Constructor & Destructor Documentation

virtual BasisTechnology::RLP::Context::~Context (  )  [virtual]


Member Function Documentation

virtual bool BasisTechnology::RLP::Context::GetConsistentType (  )  [pure virtual]

virtual cli::array<NamedEntityData^> ^ BasisTechnology::RLP::Context::GetNamedEntityResultData ( bool  StripAffixes  )  [pure virtual]

virtual String ^ BasisTechnology::RLP::Context::GetProcessorReport (  )  [pure virtual]

Returns:
the report string. The format is ProcName0|Description0|ProcName1|Description1|...|ProcNameN|DescriptionN||

virtual String ^ BasisTechnology::RLP::Context::GetProperty ( String^   property  )  [pure virtual]

Parameters:
property the name of the property
Returns:
the property value, or null.

virtual Object ^ BasisTechnology::RLP::Context::GetResultData ( ResultType  resultType,
bool  safeDataOnly 
) [pure virtual]

Parameters:
resultType the type of data to return.
safeDataOnly if true, then some return types change to avoid unsafe pointers.
Returns:
the returned data, or null.

For many of the result types, GetResultData returns an ordinary managed object.

For several result types, GetResultData returns an unsafe pointer to data we already have unless the safeDataOnly flag is set. This avoids the cost of copying the data. To return a managed copy of the original data, set safeDataOnly to true.

Entity TypeReturn typeSafe return typeComments
TOKENstring[]string[]One string per-token>
PART_OF_SPEECHstring[]string[]One string per-token
SENTENCE_BOUNDARYIntegerVectorValueSafeIntegerVectorValueOne integer per sentence; token index of the boundary token
BASE_NOUN_PHRASEIntegerVectorValueSafeIntegerVectorValueTwo integers per phrase; token indices of the start and end
DETECTED_LANGUAGEuint (boxed)uint (boxed)Actually a LanguageID
DETECTED_ENCODINGStringStringMIME charset or MIME type of the input data
NAMED_ENTITYIntegerVectorValueSafeIntegerVectorValueThree integers per phrase; token indices of the start and end plus the entity type
TOKEN_OFFSETIntegerVectorValueSafeIntegerVectorValueTwo integers per token; character indices of the start and end.
STEMstring[]string[]Stemmed form of the each token.
NORMALIZED_TOKENstring[]string[]Normalized form of the each token; not all languages/processors produce this result type.
COMPOUNDHashtableHashtableThe keys are uint token indices, and the values are string[] arrays of compound components.
READINGHashtableHashtableThe keys are uint token indices, and the values are string[] arrays of alternative reading.
RAW_TEXTSingletonStringValuechar[]The input data, converted to UTF-16
STOPWORDIntegerVectorValueSafeIntegerVectorValue1One integer per stop-word; the indices of the tokens identified as stopwords.

virtual void BasisTechnology::RLP::Context::ProcessBuffer ( cli::array< System::Byte >^  data,
LanguageID  language,
String^   encoding,
String^   mime_type 
) [pure virtual]

Parameters:
data the input data to process.
language the language, or LanguageID.UNKNOWN, of the input data.
encoding the encoding of the input file. Null if unknown.
mime_type the MIME character set or type of the input file. Null if unknown.

virtual void BasisTechnology::RLP::Context::ProcessBuffer ( cli::array< System::Char >^  data,
LanguageID  language 
) [pure virtual]

Parameters:
data the input data to process.
language the language, or LanguageID.UNKNOWN, of the input data.

virtual void BasisTechnology::RLP::Context::ProcessBuffer ( String^   data,
LanguageID  language 
) [pure virtual]

Parameters:
data the input data to process.
language the language, or LanguageID.UNKNOWN, of the input data.

virtual void BasisTechnology::RLP::Context::ProcessFile ( String^   data_file_pathname,
LanguageID  language,
String^   encoding,
String^   mime_type 
) [pure virtual]

Parameters:
data_file_pathname the input data to process.
language the language, or LanguageID.UNKNOWN, of the input data.
encoding the encoding of the input file. Null if unknown.
mime_type the MIME character set or type of the input file. Null if unknown.

virtual void BasisTechnology::RLP::Context::SetConsistentType ( bool  flag  )  [pure virtual]

virtual void BasisTechnology::RLP::Context::SetProperty ( String^   property,
String^   value 
) [pure virtual]

Parameters:
property the name of the property
value the value of the property


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

Copyright © 2004-2008 Basis Technology Corporation. All Rights Reserved.