Overview   Class List   Class Hierarchy   Class Members   Functions & Constants   Defines   Header Files  

uima::NameValuePair Class Reference

Inherits uima::MetaDataObject.

List of all members.


Detailed Description

Contains the value for a certain parameter.

The parameter name is determined bygetName(). Has severalextractValuemethods to extract the value according to its type. These methods will returnUIMA_ERR_CONFIG_INVALID_EXRACTOR_FOR_TYPE if the value type does not match the type in theextractValuemethod.

Public Types

typedef std::vector
< icu::UnicodeString > 
TyStrValueList
typedef std::vector< int > TyIntValueList
typedef std::vector< float > TyFloatValueList
typedef std::vector< bool > TyBoolValueList

Public Member Functions

 NameValuePair ()
void commit ()
 Does nothing, as reconfiguration of parameter values is possible.
void setName (const icu::UnicodeString &name)
const icu::UnicodeString & getName () const
void define (ConfigurationParameter::EnParameterType type, ConfigurationParameter::EnParameterAggregation enIsMulti)
bool isMultiValued () const
ConfigurationParameter::EnParameterType getType () const
TyErrorId setValue (int value)
TyErrorId setValue (float value)
TyErrorId setValue (bool value)
TyErrorId setValue (const icu::UnicodeString &value)
TyErrorId addValue (int value)
TyErrorId addValue (float value)
TyErrorId addValue (bool value)
TyErrorId addValue (const icu::UnicodeString &value)
bool extractBoolValue () const
std::vector< bool > const & extractBoolValues () const
int extractIntValue () const
std::vector< int > const & extractIntValues () const
float extractFloatValue () const
std::vector< float > const & extractFloatValues () const
icu::UnicodeString const & extractStringValue () const
std::vector
< icu::UnicodeString > const & 
extractStringValues () const
std::string extractSingleByteStringValue () const
void extractSingleByteStringValues (std::vector< std::string * > &values) const
bool isModifiable () const

Protected Attributes

bool iv_bIsModifiable


Member Typedef Documentation

typedef std::vector< icu::UnicodeString > uima::NameValuePair::TyStrValueList

typedef std::vector< int > uima::NameValuePair::TyIntValueList

typedef std::vector< float > uima::NameValuePair::TyFloatValueList

typedef std::vector< bool > uima::NameValuePair::TyBoolValueList


Constructor & Destructor Documentation

uima::NameValuePair::NameValuePair (  ) 


Member Function Documentation

void uima::NameValuePair::commit (  )  [inline, virtual]

Does nothing, as reconfiguration of parameter values is possible.

Reimplemented from uima::MetaDataObject.

void uima::NameValuePair::setName ( const icu::UnicodeString &  name  )  [inline]

const icu::UnicodeString& uima::NameValuePair::getName (  )  const [inline]

void uima::NameValuePair::define ( ConfigurationParameter::EnParameterType  type,
ConfigurationParameter::EnParameterAggregation  enIsMulti 
)

bool uima::NameValuePair::isMultiValued (  )  const [inline]

ConfigurationParameter::EnParameterType uima::NameValuePair::getType (  )  const [inline]

TyErrorId uima::NameValuePair::setValue ( int  value  ) 

TyErrorId uima::NameValuePair::setValue ( float  value  ) 

TyErrorId uima::NameValuePair::setValue ( bool  value  ) 

TyErrorId uima::NameValuePair::setValue ( const icu::UnicodeString &  value  ) 

TyErrorId uima::NameValuePair::addValue ( int  value  ) 

TyErrorId uima::NameValuePair::addValue ( float  value  ) 

TyErrorId uima::NameValuePair::addValue ( bool  value  ) 

TyErrorId uima::NameValuePair::addValue ( const icu::UnicodeString &  value  ) 

bool uima::NameValuePair::extractBoolValue (  )  const

std::vector<bool> const& uima::NameValuePair::extractBoolValues (  )  const

int uima::NameValuePair::extractIntValue (  )  const

std::vector<int> const& uima::NameValuePair::extractIntValues (  )  const

float uima::NameValuePair::extractFloatValue (  )  const

std::vector<float> const& uima::NameValuePair::extractFloatValues (  )  const

icu::UnicodeString const& uima::NameValuePair::extractStringValue (  )  const

std::vector<icu::UnicodeString> const& uima::NameValuePair::extractStringValues (  )  const

std::string uima::NameValuePair::extractSingleByteStringValue (  )  const

void uima::NameValuePair::extractSingleByteStringValues ( std::vector< std::string * > &  values  )  const

bool uima::MetaDataObject::isModifiable (  )  const [inline, inherited]


Member Data Documentation

bool uima::MetaDataObject::iv_bIsModifiable [protected, inherited]


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

Generated on Mon Oct 1 11:15:08 2012 for UIMACPP API by  doxygen 1.5.6