strusJava  0.14
Public Member Functions | Friends | List of all members
net::strus::api::Aggregator Class Reference

Object representing a aggregator function definition. More...

#include <bindingObjects.hpp>

Public Member Functions

 Aggregator ()
 Default constructor. More...
 
 Aggregator (const Aggregator &o)
 Copy constructor. More...
 
 Aggregator (const String &name_, const StringVector &arg_)
 Constructor. More...
 
 Aggregator (const String &name_, const String &arg_)
 Constructor. More...
 
 Aggregator (const String &name_, const String &arg1_, const String &arg2_)
 Constructor. More...
 
 Aggregator (const String &name_)
 Constructor. More...
 
 ~Aggregator ()
 Destructor. More...
 
const String & name () const
 Get the name of the aggregator function. More...
 
const StringVector & arguments () const
 Get the arguments of the aggregator function. More...
 
void setName (const String &name_)
 Set the name of the aggregator function. More...
 
void addArgument (const String &arg_)
 Add an argument to the aggregator function. More...
 
void addArgumentInt (long arg_)
 Add a numeric argument to the aggregator function. More...
 
void addArgumentFloat (double arg_)
 Add a numeric argument to the aggregator function. More...
 

Friends

class DocumentAnalyzer
 

Detailed Description

Object representing a aggregator function definition.

Constructor & Destructor Documentation

net::strus::api::Aggregator::Aggregator ( )
inline

Default constructor.

net::strus::api::Aggregator::Aggregator ( const Aggregator o)
inline

Copy constructor.

net::strus::api::Aggregator::Aggregator ( const String &  name_,
const StringVector &  arg_ 
)
inline

Constructor.

Parameters
[in]name_name of the aggregator function
[in]arg_arguments of the aggregator function
net::strus::api::Aggregator::Aggregator ( const String &  name_,
const String &  arg_ 
)
inline

Constructor.

Parameters
[in]name_name of the aggregator function
[in]arg_single argument of the aggregator function
net::strus::api::Aggregator::Aggregator ( const String &  name_,
const String &  arg1_,
const String &  arg2_ 
)
inline

Constructor.

Parameters
[in]name_name of the aggregator function
[in]arg1_first argument of the aggregator function
[in]arg2_second argument of the aggregator function
net::strus::api::Aggregator::Aggregator ( const String &  name_)
inline

Constructor.

Parameters
[in]name_name of the aggregator function
net::strus::api::Aggregator::~Aggregator ( )
inline

Destructor.

Member Function Documentation

void net::strus::api::Aggregator::addArgument ( const String &  arg_)
inline

Add an argument to the aggregator function.

Parameters
[in]arg_the argument to add
void net::strus::api::Aggregator::addArgumentFloat ( double  arg_)

Add a numeric argument to the aggregator function.

Parameters
[in]arg_the argument to add
void net::strus::api::Aggregator::addArgumentInt ( long  arg_)

Add a numeric argument to the aggregator function.

Parameters
[in]arg_the argument to add
const StringVector& net::strus::api::Aggregator::arguments ( ) const
inline

Get the arguments of the aggregator function.

Returns
the arguments
const String& net::strus::api::Aggregator::name ( ) const
inline

Get the name of the aggregator function.

Returns
the name
void net::strus::api::Aggregator::setName ( const String &  name_)
inline

Set the name of the aggregator function.

Parameters
[in]name_the name

Friends And Related Function Documentation

friend class DocumentAnalyzer
friend

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