The ShingleFilter type exposes the following members.

Constructors

  NameDescription
Public methodShingleFilter(TokenStream)
Construct a ShingleFilter with default shingle size.
Public methodShingleFilter(TokenStream, Int32)
Constructs a ShingleFilter with the specified single size from the TokenStream
Public methodShingleFilter(TokenStream, String)
Construct a ShingleFilter with the specified token type for shingle tokens.

Methods

  NameDescription
Public methodAddAttribute
The caller must pass in a Class<? extends Attribute> value. 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. Signature for Java 1.5:
CopyC#
public <T extends Attribute> T addAttribute(Class<T>)
(Inherited from AttributeSource.)
Public methodAddAttributeImpl
Adds a custom AttributeImpl instance with one or more Attribute interfaces.
(Inherited from AttributeSource.)
Public methodCaptureState
Captures the state of all Attributes. The return value can be passed to {@link #restoreState} to restore the state of this or another AttributeSource.
(Inherited from AttributeSource.)
Public methodClearAttributes
Resets all Attributes in this AttributeSource by calling {@link AttributeImpl#Clear()} on each Attribute implementation.
(Inherited from AttributeSource.)
Public methodCloneAttributes
Performs a clone of all {@link AttributeImpl} instances returned in a new AttributeSource instance. This method can be used to e.g. create another TokenStream with exactly the same attributes (using {@link #AttributeSource(AttributeSource)})
(Inherited from AttributeSource.)
Public methodClose
Close the input TokenStream.
(Inherited from TokenFilter.)
Public methodEnd
Performs end-of-stream operations, if any, and calls then
CopyC#
end()
on the input TokenStream.

NOTE: Be sure to call

CopyC#
super.end()
first when overriding this method.
(Inherited from TokenFilter.)
Public methodEquals (Inherited from AttributeSource.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAttribute
The caller must pass in a Class<? extends Attribute> value. Returns the instance of the passed in Attribute contained in this AttributeSource Signature for Java 1.5:
CopyC#
public <T extends Attribute> T getAttribute(Class<T>)
(Inherited from AttributeSource.)
Public methodGetAttributeClassesIterator
Returns a new iterator that iterates the attribute classes in the same order they were added in. Signature for Java 1.5:
CopyC#
public Iterator<Class<? extends Attribute>> getAttributeClassesIterator()
Note that this return value is different from Java in that it enumerates over the values and not the keys
(Inherited from AttributeSource.)
Public methodGetAttributeFactory
returns the used AttributeFactory.
(Inherited from AttributeSource.)
Public methodGetAttributeImplsIterator
Returns a new iterator that iterates all unique Attribute implementations. This iterator may contain less entries that {@link #getAttributeClassesIterator}, if one instance implements more than one Attribute interface. Signature for Java 1.5:
CopyC#
public Iterator<AttributeImpl> getAttributeImplsIterator()
(Inherited from AttributeSource.)
Public methodGetHashCode (Inherited from AttributeSource.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasAttribute
The caller must pass in a Class<? extends Attribute> value. Returns true, iff this AttributeSource contains the passed-in Attribute. Signature for Java 1.5:
CopyC#
public boolean hasAttribute(Class<? extends Attribute>)
(Inherited from AttributeSource.)
Public methodHasAttributes
Returns true, iff this AttributeSource has any attributes
(Inherited from AttributeSource.)
Public methodIncrementToken
See Lucene.Net.Analysis.TokenStream.Next()
(Overrides TokenStream..::..IncrementToken()()()().)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNext()()()() Obsolete.
Deprecated: Will be removed in Lucene 3.0. This method is readonly, as it should not be overridden. Delegates to the backwards compatibility layer.
(Overrides TokenStream..::..Next()()()().)
Public methodNext(Token) Obsolete.
Deprecated: Will be removed in Lucene 3.0. This method is readonly, as it should not be overridden. Delegates to the backwards compatibility layer.
(Overrides TokenStream..::..Next(Token).)
Public methodReset (Overrides TokenFilter..::..Reset()()()().)
Public methodRestoreState
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 (e.g. 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 {@link TokenStream#ClearAttributes()} on the targetStream.
(Inherited from AttributeSource.)
Public methodSetMaxShingleSize
Set the max shingle size (default: 2)
Public methodSetOutputUnigrams
Shall the output stream contain the input tokens (unigrams) as well as shingles? (default: true.)
Public methodSetTokenType
Set the type of the shingle tokens produced by this filter. (default: "shingle")
Public methodToString (Inherited from AttributeSource.)

Fields

  NameDescription
Public fieldStatic memberDefaultMaxShingleSize
Default maximum shingle size is 2.
Public fieldStatic memberFillerToken
Filler token for when positionIncrement is more than 1
Protected fieldinput
The source of tokens for this filter.
(Inherited from TokenFilter.)
Public fieldStatic memberTokenSeparator
The string to use when joining adjacent tokens to form a shingle

See Also