pion::platform::Transform Class Reference

Inherited by pion::platform::TransformAssignTerm, pion::platform::TransformAssignValue, pion::platform::TransformJoinTerm, pion::platform::TransformLookup, pion::platform::TransformRegex, pion::platform::TransformRules, pion::platform::TransformSplitTerm, pion::platform::TransformURLDecode, and pion::platform::TransformURLEncode.

List of all members.

---

Detailed Description

Definition at line 43 of file Transform.hpp.

Public Member Functions
virtual	~Transform ()
	virtual destructor: you may extend this class
	Transform (const Vocabulary &v, const Vocabulary::Term &term)
void	updateVocabulary (const Vocabulary &v)
void	removeTerm (EventPtr &e)
virtual bool	transform (EventPtr &d, const EventPtr &s)=0
Public Attributes
Vocabulary::Term	m_term
	identifies the Vocabulary Term that is being tested (for regex)
Static Public Attributes
static const std::string	LOOKUP_TERM_NAME = "LookupTerm"
	Definitions for static ELEMENT NAMEs.
static const std::string	TERM_ELEMENT_NAME = "Term"
static const std::string	LOOKUP_MATCH_ELEMENT_NAME = "Match"
static const std::string	LOOKUP_FORMAT_ELEMENT_NAME = "Format"
static const std::string	LOOKUP_DEFAULT_ELEMENT_NAME = "DefaultValue"
static const std::string	VALUE_ELEMENT_NAME = "Value"
static const std::string	RULES_STOP_ON_FIRST_ELEMENT_NAME = "StopOnFirstMatch"
static const std::string	RULE_ELEMENT_NAME = "Rule"
static const std::string	TYPE_ELEMENT_NAME = "Type"
static const std::string	TRANSFORMATION_SET_VALUE_NAME = "SetValue"
static const std::string	LOOKUP_DEFAULTACTION_ELEMENT_NAME = "DefaultAction"
static const std::string	LOOKUP_LOOKUP_ELEMENT_NAME = "Lookup"
static const std::string	LOOKUP_KEY_ATTRIBUTE_NAME = "key"
static const std::string	SOURCE_TERM_ELEMENT_NAME = "SourceTerm"
static const std::string	REGEXP_ELEMENT_NAME = "Regex"
static const std::string	REGEXP_ATTRIBUTE_NAME = "exp"
static const std::string	SEP_ATTRIBUTE_NAME = "sep"
static const std::string	UNIQ_ATTRIBUTE_NAME = "uniq"
Classes
class	MissingTransformField
	invalid/missing type of transformation More...
class	RegexFailure
	exception thrown if regex_replace fails and throws More...
class	ValueAssignmentException
	exception thrown if AssignValue catches an exception More...

---

Constructor & Destructor Documentation

pion::platform::Transform::Transform	(	const Vocabulary &	v,
		const Vocabulary::Term &	term
	)			[inline]

constructs a new Transform rule

Parameters:

	term	the term that will be examined
	set_term	the term that will be set (if not InPlace)

Definition at line 81 of file Transform.hpp.

---

Member Function Documentation

void pion::platform::Transform::removeTerm

(

EventPtr &

e

)

[inline]

removeTerm removes m_term.term_ref value(s) from event

Parameters:

e

EventPtr pointing to event, where value will be removed from

Definition at line 102 of file Transform.hpp.

virtual bool pion::platform::Transform::transform	(	EventPtr &	d,
		const EventPtr &	s
	)			[pure virtual]

transforms event terms

Parameters:

e

the Event to transform

Returns:

true if the Transformation occured; false if it did not

Implemented in pion::platform::TransformAssignValue, pion::platform::TransformAssignTerm, pion::platform::TransformURLEncode, pion::platform::TransformURLDecode, pion::platform::TransformSplitTerm, pion::platform::TransformJoinTerm, pion::platform::TransformLookup, pion::platform::TransformRules, and pion::platform::TransformRegex.

void pion::platform::Transform::updateVocabulary

(

const Vocabulary &

v

)

[inline]

updateVocabulary Updates all Transform classes to use new vocabulary value

Parameters:

v

New vocabulary object, updates only m_term for each class

Definition at line 91 of file Transform.hpp.

---

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

• platform/include/pion/platform/Transform.hpp
• platform/src/Transform.cpp

---