---

             

---

uima::ResultSpecification Class Reference

List of all members.

---

Detailed Description

An engine/annotator gets a set like this passed in its process() function and is required to check this set to see which kind of output types and features it is supposed to create.

An annotator which produces only one kind of output can skip this check since is made sure that the set only contains types/features which the annotator is capable of producing and would never call an annotator that is not required at all. So this set is most relevant for multi-purpose annotators to determine which of their various functions are required for this specific document.

Public Types
typedef std::set< TypeOrFeature >	TyTypeOrFeatureSTLSet
Public Member Functions
bool	shouldBeCreatedByAnnotator (TypeOrFeature const &crTypeOrFeature) const
	An annotator can call this method to determine whether it should produce the specified TypeOrFeature.
TyTypeOrFeatureSTLSet const &	getTypeOrFeatureSTLSet () const
void	clear ()
size_t	getSize () const
void	add (TypeOrFeature const &crTypeOrFeature)
void	remove (TypeOrFeature const &crTypeOrFeature)
bool	contains (TypeOrFeature const &crTypeOrFeature) const
void	print (std::ostream &os) const

---

Member Typedef Documentation

typedef std::set< TypeOrFeature > uima::ResultSpecification::TyTypeOrFeatureSTLSet

---

Member Function Documentation

bool uima::ResultSpecification::shouldBeCreatedByAnnotator (  TypeOrFeature const &  crTypeOrFeature  )  const [inline]

An annotator can call this method to determine whether it should produce the specified TypeOrFeature.

TyTypeOrFeatureSTLSet const& uima::ResultSpecification::getTypeOrFeatureSTLSet (   )  const [inline]

void uima::ResultSpecification::clear (   )  [inline]

size_t uima::ResultSpecification::getSize (   )  const [inline]

void uima::ResultSpecification::add (  TypeOrFeature const &  crTypeOrFeature  )  [inline]

void uima::ResultSpecification::remove (  TypeOrFeature const &  crTypeOrFeature  )  [inline]

bool uima::ResultSpecification::contains (  TypeOrFeature const &  crTypeOrFeature  )  const [inline]

void uima::ResultSpecification::print (  std::ostream &  os  )  const [inline]

---

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

• result_specification.hpp

---