Keyoti SearchUnit API Docs
Element Class
API DocumentationKeyoti.SearchEngine.SearchElement
Keyoti SearchUnit v6
Base class for all query elements, see remarks.
Declaration Syntax
C#Visual Basic
public abstract class Element
Public MustInherit Class Element
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Element(Configuration)
Creates an instance of Element class.

Configuration
The instance of the Configuration class that holds the settings to be used.

Content
Returns a string representing the content of the element, this should typically be; WordElement.Content => theWord NotWordElement.Content => -theWord GroupElement.Content => null PhraseElement.Content => thePhrase (no quotes)

CreateLexiconQueries(SearcherIO)
Creates the LexiconQuery objects for this element.

elementQueryCollection
The lexicon queries used for the element

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetIgnoredWords()()()()
Returns the stop words from the original query that were ignored.

GetMatchingDocumentIDs(SearcherIO, IntHashtable, SearchOptions, Hashtable)
Gets all document IDs matching this element.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
IsStopWord()()()()
Whether is stop word.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Remarks
A search query contains one or more 'elements' - these are identified as follows.
  • PhraseElement - a part of a query between quotes, eg. "this phrase"
  • GroupElement - a part of a query between brackets, eg. (this group). Typically holds other elements within it.
  • NotWordElement - a word in the query marked with a minus sign, eg. -excludeMe
  • WordElement - a word in the query, eg. this
Inheritance Hierarchy

Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2022.8.22.610