Keyoti SearchUnit API Docs
XmlDataAccess Class
API DocumentationKeyoti.SearchEngine.DataAccessXmlDataAccess
Keyoti SearchUnit v6
Provides access to the data stored as XML files
Declaration Syntax
C#Visual Basic
public class XmlDataAccess
Public Class XmlDataAccess
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
XmlDataAccess(Configuration)
The facade for the entire data access layer.

AddContent(String) Obsolete.
Adds a content type to the index.

AddContent(ContentCategoryRecord)
Adds a content type to the index.

AddIndexableSourceRecord(IndexableSourceRecord)
Adds an indexable source record to the index.

AddLocation(LocationCategoryRecord)
Adds a new location to the index.

AddSecurityGroup(SecurityGroupRecord)
Adds a new security group to the index.

AutoAssignContentCategory(DocumentRecord, Boolean)
Automatically assigns the content category.

AutoAssignLocationCategory(DocumentRecord, Boolean)
Automatically assigns the location category.

AutoAssignSecurityGroup(DocumentRecord, Boolean)
Automatically assigns the security group.

Close()()()()
Updates the files with any modifications made since Open was called.

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

EnsureDataStore()()()()
Creates files if some of them don't exist

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.)
GetContentCategories()()()()
Returns list of contents known in the index.

GetContentCategoryRecord(Int32)
Gets a ContentCategoryRecord based on the id of the content record.

GetContentCategoryRecord(String)
Gets a ContentCategoryRecord based on the name of the content record.

GetContentID(String)
Get's the ID corresponding to a content category name.

GetDocumentID(Uri) Obsolete.
Returns the document ID of the document specified by uri

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetIndexableSourceRecords()()()()
Gets list of IndexableSourceRecords contained in the index.

GetIndexState()()()()
Gets the index state

GetLastIndexDate()()()()
Returns the date when the last indexing was performed

GetLocationCategories()()()()
Returns list of locations known in the index.

GetLocationCategoryRecord(String)
Gets a LocationCategoryRecord based on the locationName.

GetLocationCategoryRecord(Int32)
Gets a LocationCategoryRecord based on the locationID.

GetLocationID(String)
Get's the ID corresponding to a location category name.

GetMatchingDocumentsAndOccurrencesForWord(String, ArrayList, Hashtable, SearchOptions, Boolean) Obsolete.
Gets an OccurrenceMap for a word.

GetMatchingDocumentsAndOccurrencesForWord(LexiconMatch, Hashtable, SearchOptions) Obsolete.
Obsolete

GetMatchingDocumentsAndOccurrencesWord(LexiconMatch, Hashtable, SearchOptions) Obsolete.
Gets an OccurrenceMap for a word.

GetSecurityGroupRecord(String)
Gets a SecurityGroupRecord based on the securityGroupName.

GetSecurityGroupRecord(Int32)
Gets a SecurityGroupRecord based on the locationID.

GetSecurityGroups()()()()
Returns list of security groups known in the index.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
GetWordVariations(Word) Obsolete.
Returns list of string objects with variations (lemmas) for a word, empty list if none found.

IsContentUsed(String) Obsolete.
Returns true if contentName is used by at least one document

IsIndexValid()()()()
Returns whether the current document index is complete.

IsLocationUsed(String) Obsolete.
Returns true if locationName is used by at least one document

IsOpen
Whether this is open.

LockMarkDateTime()()()()
Determines when the index is marked locked. If it isn't locked then DateTime.MinValue is returned.

MarkIndexLocked(Boolean)
Marks the index directory as locked/unlocked

MarkIndexValid(Boolean)
Marks the current document index as valid or not.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Open()()()()
Opens the data access layer by ensuring that necessary files exist.

RemoveContent(String) Obsolete.
Removes a content type from the index.

RemoveIndexableSourceRecord(IndexableSourceRecord)
Removes an indexable source record to the index.

RemoveLocation(String) Obsolete.
Removes a location from the index.

SetIndexState(IndexState)
Sets the index state

StateTable
Table holding the index state

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UpdateContentCategory(ContentCategoryRecord)
Updates a ContentCategory record, except the case when updated content's name is a duplicate (which is not allowed)

UpdateIndexableSourceRecord(IndexableSourceRecord)
Updates an indexable source record to the index.

UpdateLocationCategory(LocationCategoryRecord)
Updates a locationCategory record, except the case when updated location's name is a duplicate (which is not allowed)

UpdateSecurityGroup(SecurityGroupRecord)
Updates a securityGroup record, except the case when updated location's name is a duplicate (which is not allowed)

XmlContentTable
Gets the XmlContentTable.

XmlIndexableSourceRecordTable
Holds indexable source records

XmlLocationTable
Gets the XmlLocationTable.

XmlSecurityGroupTable
Gets the XmlSecurityGroupTable.

Inheritance Hierarchy
Object
XmlDataAccess

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