Lucene++ - a full-featured, c++ search engine
API Documentation
An AttributeSource contains a list of different Attribute
s, and methods to add and get them. There can only be a single instance of an attribute in the same AttributeSource instance. This is ensured by passing in the actual type of the Attribute (Class<Attribute>) to the addAttribute(Class)
, which then checks if an instance of that type is already present. If yes, it returns the instance, otherwise it creates a new instance and returns it.
More...
#include <AttributeSource.h>
Public Member Functions | |
AttributeSource () | |
An AttributeSource using the default attribute factory DefaultAttributeFactory . | |
AttributeSource (const AttributeSourcePtr &input) | |
An AttributeSource that uses the same attributes as the supplied one. | |
AttributeSource (const AttributeFactoryPtr &factory) | |
An AttributeSource using the supplied AttributeFactory for creating new Attribute instances. | |
virtual | ~AttributeSource () |
virtual String | getClassName () |
boost::shared_ptr< AttributeSource > | shared_from_this () |
AttributeFactoryPtr | getAttributeFactory () |
returns the used AttributeFactory. | |
template<class ATTR > | |
boost::shared_ptr< ATTR > | addAttribute () |
This method first checks if an instance of that class is already in this AttributeSource and returns it. Otherwise a new instance is created, added to this AttributeSource and returned. | |
void | addAttribute (const String &className, const AttributePtr &attrImpl) |
Adds a custom Attribute instance. | |
bool | hasAttributes () |
Returns true if this AttributeSource has any attributes. | |
template<class ATTR > | |
bool | hasAttribute () |
Returns true, if this AttributeSource contains the passed-in Attribute. | |
template<class ATTR > | |
boost::shared_ptr< ATTR > | getAttribute () |
Returns the instance of the passed in Attribute contained in this AttributeSource. | |
void | clearAttributes () |
Resets all Attributes in this AttributeSource by calling AttributeImpl#clear() on each Attribute implementation. | |
AttributeSourceStatePtr | captureState () |
Captures the state of all Attributes. The return value can be passed to restoreState to restore the state of this or another AttributeSource. | |
void | restoreState (const AttributeSourceStatePtr &state) |
Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream. The targetStream must contain a corresponding instance for each argument contained in this state (eg. it is not possible to restore the state of an AttributeSource containing a TermAttribute into a AttributeSource using a Token instance as implementation). | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual String | toString () |
Returns a string representation of the object. | |
AttributeSourcePtr | cloneAttributes () |
Performs a clone of all AttributeImpl instances returned in a new AttributeSource instance. This method can be used to eg. create another TokenStream with exactly the same attributes (using AttributeSource(AttributeSource) ) | |
Collection< AttributePtr > | getAttributes () |
Return a vector of attributes based on currentState. | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. | |
Static Public Member Functions | |
static String | _getClassName () |
Protected Member Functions | |
AttributePtr | getAttribute (const String &className) |
The caller must pass in a className value. This method checks if an instance of that class is already in this AttributeSource and returns it. | |
bool | hasAttribute (const String &className) |
Returns true, if this AttributeSource contains the passed-in Attribute. | |
void | computeCurrentState () |
![]() | |
LuceneObject () | |
Protected Attributes | |
AttributeFactoryPtr | factory |
MapStringAttribute | attributes |
AttributeSourceStatePtr | currentState |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
An AttributeSource contains a list of different Attribute
s, and methods to add and get them. There can only be a single instance of an attribute in the same AttributeSource instance. This is ensured by passing in the actual type of the Attribute (Class<Attribute>) to the addAttribute(Class)
, which then checks if an instance of that type is already present. If yes, it returns the instance, otherwise it creates a new instance and returns it.
Lucene::AttributeSource::AttributeSource | ( | ) |
An AttributeSource using the default attribute factory DefaultAttributeFactory
.
Lucene::AttributeSource::AttributeSource | ( | const AttributeSourcePtr & | input | ) |
An AttributeSource that uses the same attributes as the supplied one.
Lucene::AttributeSource::AttributeSource | ( | const AttributeFactoryPtr & | factory | ) |
An AttributeSource using the supplied AttributeFactory
for creating new Attribute
instances.
|
virtual |
|
inlinestatic |
|
inline |
This method first checks if an instance of that class is already in this AttributeSource and returns it. Otherwise a new instance is created, added to this AttributeSource and returned.
void Lucene::AttributeSource::addAttribute | ( | const String & | className, |
const AttributePtr & | attrImpl | ||
) |
Adds a custom Attribute instance.
AttributeSourceStatePtr Lucene::AttributeSource::captureState | ( | ) |
Captures the state of all Attributes. The return value can be passed to restoreState
to restore the state of this or another AttributeSource.
void Lucene::AttributeSource::clearAttributes | ( | ) |
Resets all Attributes in this AttributeSource by calling AttributeImpl#clear()
on each Attribute implementation.
AttributeSourcePtr Lucene::AttributeSource::cloneAttributes | ( | ) |
Performs a clone of all AttributeImpl
instances returned in a new AttributeSource instance. This method can be used to eg. create another TokenStream with exactly the same attributes (using AttributeSource(AttributeSource)
)
|
protected |
|
virtual |
Return whether two objects are equal.
Reimplemented from Lucene::LuceneObject.
|
inline |
Returns the instance of the passed in Attribute contained in this AttributeSource.
|
protected |
The caller must pass in a className value. This method checks if an instance of that class is already in this AttributeSource and returns it.
AttributeFactoryPtr Lucene::AttributeSource::getAttributeFactory | ( | ) |
returns the used AttributeFactory.
Collection< AttributePtr > Lucene::AttributeSource::getAttributes | ( | ) |
Return a vector of attributes based on currentState.
|
inlinevirtual |
Reimplemented in Lucene::ASCIIFoldingFilter, Lucene::CachingTokenFilter, Lucene::CharTokenizer, Lucene::SingleTokenAttributeSource, Lucene::ISOLatin1AccentFilter, Lucene::KeywordTokenizer, Lucene::LengthFilter, Lucene::LetterTokenizer, Lucene::LowerCaseFilter, Lucene::LowerCaseTokenizer, Lucene::NumericTokenStream, Lucene::PorterStemFilter, Lucene::StandardFilter, Lucene::StandardTokenizer, Lucene::StopFilter, Lucene::TeeSinkTokenFilter, Lucene::SinkTokenStream, Lucene::TokenFilter, Lucene::Tokenizer, Lucene::TokenStream, and Lucene::WhitespaceTokenizer.
|
inline |
Returns true, if this AttributeSource contains the passed-in Attribute.
|
protected |
Returns true, if this AttributeSource contains the passed-in Attribute.
bool Lucene::AttributeSource::hasAttributes | ( | ) |
Returns true if this AttributeSource has any attributes.
|
virtual |
Return hash code for this object.
Reimplemented from Lucene::LuceneObject.
void Lucene::AttributeSource::restoreState | ( | const AttributeSourceStatePtr & | state | ) |
Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream. The targetStream must contain a corresponding instance for each argument contained in this state (eg. it is not possible to restore the state of an AttributeSource containing a TermAttribute into a AttributeSource using a Token instance as implementation).
Note that this method does not affect attributes of the targetStream that are not contained in this state. In other words, if for example the targetStream contains an OffsetAttribute, but this state doesn't, then the value of the OffsetAttribute remains unchanged. It might be desirable to reset its value to the default, in which case the caller should first call TokenStream#clearAttributes()
on the targetStream.
|
inline |
|
virtual |
Returns a string representation of the object.
Reimplemented from Lucene::LuceneObject.
Reimplemented in Lucene::NumericTokenStream.
|
protected |
|
protected |
|
protected |