Class FreeTextIndexRows

This is the index table for the free text search function. Each word in FreeTextWords can have multiple occurrences in this table. Each record in this table points to one occurrence of the word, and points to both the table in which the word occurs (which might be contact or text), and also a pointer to the owner table (which is one of contact, person, project, appointment or sale). Collection of FreeTextIndexRow. Each element of the collection represents one row in the FreeTextIndex table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
FreeTextIndexRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class FreeTextIndexRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
Remarks

Row collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type FreeTextIndexRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) FreeTextIndexRows FreeTextIndexRows.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(FreeTextIndexRows.CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the FreeTextIndexRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, FreeTextIndexTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

Item[Int32]

Get a FreeTextIndexRow given its index in the collection.

Declaration
public FreeTextIndexRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the FreeTextIndexRow in the collection
Property Value
Type Description
FreeTextIndexRow

Methods

Add(FreeTextIndexRow)

Add one FreeTextIndexRow to the collection.

Declaration
public int Add(FreeTextIndexRow row)
Parameters
Type Name Description
FreeTextIndexRow row

An instance of FreeTextIndexRow to be added to the collection.
Returns
Type Description
Int32

The index of the added FreeTextIndexRow.

AddNew()

Add a new instance of FreeTextIndexRow added to the collection.

Declaration
public FreeTextIndexRow AddNew()
Returns
Type Description
FreeTextIndexRow

A new instance of FreeTextIndexRow added to the collection.

AddRange(IEnumerable<FreeTextIndexRow>)

Add a range of FreeTextIndexRow to the collection.

Declaration
public FreeTextIndexRows AddRange(IEnumerable<FreeTextIndexRow> rows)
Parameters
Type Name Description
IEnumerable<FreeTextIndexRow> rows
Returns
Type Description
FreeTextIndexRows

The updated FreeTextIndexRows collection object.

CreateChild()

Create a new instance of FreeTextIndexRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of FreeTextIndexRow
Overrides

CreateNew()

Create a new instance of the FreeTextIndexRows object. This collection will contain no rows.

Declaration
public static FreeTextIndexRows CreateNew()
Returns
Type Description
FreeTextIndexRows

A new instance of the FreeTextIndexRows object.

Find(Predicate<FreeTextIndexRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration
public FreeTextIndexRow Find(Predicate<FreeTextIndexRow> condition)
Parameters
Type Name Description
Predicate<FreeTextIndexRow> condition
Returns
Type Description
FreeTextIndexRow

FindAll(Predicate<FreeTextIndexRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration
public FreeTextIndexRows FindAll(Predicate<FreeTextIndexRow> condition)
Parameters
Type Name Description
Predicate<FreeTextIndexRow> condition
Returns
Type Description
FreeTextIndexRows

ForEach(Action<FreeTextIndexRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration
public void ForEach(Action<FreeTextIndexRow> whatToDo)
Parameters
Type Name Description
Action<FreeTextIndexRow> whatToDo

GetFromCustomSearch(FreeTextIndexRows.CustomSearch)

Create a new instance of the FreeTextIndexRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of FreeTextIndexRow objects representing each row will be returned.

Declaration
public static FreeTextIndexRows GetFromCustomSearch(FreeTextIndexRows.CustomSearch query)
Parameters
Type Name Description
FreeTextIndexRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
FreeTextIndexRows

A new instance of the FreeTextIndexRows object, reflecting the result of the query.

GetFromIdxContactId(Int32)

Create a new instance of the FreeTextIndexRow object, by querying the database table via the index 'IDXFtIdxContact_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static FreeTextIndexRows GetFromIdxContactId(int contactId)
Parameters
Type Name Description
Int32 contactId
Returns
Type Description
FreeTextIndexRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the FreeTextIndex table. Non-unique indexes have corresponding inner classes and methods in the FreeTextIndexRows collection, since they may return more than one row.

GetFromIdxFreetextwordsId(Int32)

Create a new instance of the FreeTextIndexRow object, by querying the database table via the index 'IWord_idOwnertable_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static FreeTextIndexRows GetFromIdxFreetextwordsId(int freetextwordsId)
Parameters
Type Name Description
Int32 freetextwordsId
Returns
Type Description
FreeTextIndexRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the FreeTextIndex table. Non-unique indexes have corresponding inner classes and methods in the FreeTextIndexRows collection, since they may return more than one row.

GetFromIdxFreetextwordsIdOwnertableId(Int32, Int16)

Create a new instance of the FreeTextIndexRow object, by querying the database table via the index 'IWord_idOwnertable_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static FreeTextIndexRows GetFromIdxFreetextwordsIdOwnertableId(int freetextwordsId, short ownertableId)
Parameters
Type Name Description
Int32 freetextwordsId
Int16 ownertableId
Returns
Type Description
FreeTextIndexRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the FreeTextIndex table. Non-unique indexes have corresponding inner classes and methods in the FreeTextIndexRows collection, since they may return more than one row.

GetFromIdxTableId(Int16)

Create a new instance of the FreeTextIndexRow object, by querying the database table via the index 'ITable_idRecord_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static FreeTextIndexRows GetFromIdxTableId(short tableId)
Parameters
Type Name Description
Int16 tableId
Returns
Type Description
FreeTextIndexRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the FreeTextIndex table. Non-unique indexes have corresponding inner classes and methods in the FreeTextIndexRows collection, since they may return more than one row.

GetFromIdxTableIdRecordId(Int16, Int32)

Create a new instance of the FreeTextIndexRow object, by querying the database table via the index 'ITable_idRecord_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static FreeTextIndexRows GetFromIdxTableIdRecordId(short tableId, int recordId)
Parameters
Type Name Description
Int16 tableId
Int32 recordId
Returns
Type Description
FreeTextIndexRows

Row object that represents the result of the search. will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the FreeTextIndex table. Non-unique indexes have corresponding inner classes and methods in the FreeTextIndexRows collection, since they may return more than one row.

GetFromReader(SoDataReader, FreeTextIndexTableInfo)

Create a new instance of the FreeTextIndexRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of FreeTextIndexRow objects representing each row will be returned.

Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.

Declaration
public static FreeTextIndexRows GetFromReader(SoDataReader reader, FreeTextIndexTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
FreeTextIndexTableInfo tableInfo

FreeTextIndexTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
Returns
Type Description
FreeTextIndexRows

Remove(FreeTextIndexRow)

Removes the given FreeTextIndexRow from the collection

Declaration
public void Remove(FreeTextIndexRow row)
Parameters
Type Name Description
FreeTextIndexRow row

the FreeTextIndexRow to be removed

ToArray()

Declaration
public FreeTextIndexRow[] ToArray()
Returns
Type Description
FreeTextIndexRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)