FilterCollection Class

ScaleOut Software NamedCache API
An IFilter implementation that may be used as the filter parameter in Query methods to select the objects to be returned.
Inheritance Hierarchy

SystemObject
  Soss.ClientIndexCollection
    Soss.ClientFilterCollection

Namespace:  Soss.Client
Assembly:  soss_svcdotnet (in soss_svcdotnet.dll) Version: 6.1.0.0 (1.0.0.0)
Syntax

public class FilterCollection : IndexCollection, 
	IFilter

The FilterCollection type exposes the following members.

Constructors

  NameDescription
Public methodFilterCollection
Create a new FilterCollection instance.
Public methodFilterCollection(MatchOptions)
Create a new FilterCollection instance, allowing the specification of an initial MatchOptions value.
Top
Properties

  NameDescription
Public propertyCount
Gets the number of elements in the IndexCollection. Since the collection is fixed-size, this property always returns MaxIndexValues.
(Inherited from IndexCollection.)
Public propertyIsFixedSize
Returns true.
(Inherited from IndexCollection.)
Public propertyIsReadOnly
Returns false.
(Inherited from IndexCollection.)
Public propertyIsSynchronized
Returns false. Callers may synchronize the list using SyncRoot.
(Inherited from IndexCollection.)
Public propertyItem
Gets or sets the element at the specified index.
(Inherited from IndexCollection.)
Public propertyMatchOptions
Gets or sets a value specifying whether State Server should match objects where any or all of the metadata IndexValues match this FilterCollection's (positional) IndexValues.
Public propertySyncRoot
Gets an object that can be used to synchronize access to the IndexCollection.
(Inherited from IndexCollection.)
Top
Methods

  NameDescription
Public methodClear
Sets the value of all IndexValue instances in the collection to null.
(Inherited from IndexCollection.)
Public methodClear(Int32)
Sets the value of the IndexValue instance at the specified index to a default (unused) value.
(Inherited from IndexCollection.)
Public methodContains
Tests to see if the collection contains value. Note that IndexValues are compared by value, not by reference. See Equals(Object).
(Inherited from IndexCollection.)
Public methodCopyTo
Copies the entire contents of this collection to a compatible, one-dimensional Array, starting at the specified index in the target array.
(Inherited from IndexCollection.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetEnumerator
Returns an enumerator for this IndexCollection.
(Inherited from IndexCollection.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIndexCollection
Return this IndexCollection.
(Inherited from IndexCollection.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified IndexValue and returns the zero-based index of the first occurrence within the IndexCollection.
(Inherited from IndexCollection.)
Public methodInsert
Inserts an element into the IndexCollection at the specified index.
(Inherited from IndexCollection.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove
Removes the first occurrence of a specific IndexValue from the IndexCollection.
(Inherited from IndexCollection.)
Public methodRemoveAt
Removes the element at the specified index of the IndexCollection.
(Inherited from IndexCollection.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

A FilterCollection holds an ordered set of IndexValues. When supplied to a Query operation, State Server locates objects within the object store that have metadata matching the (positional) values specified in the FilterCollection. The MatchOptions property may be used to indicate whether all metadata IndexValues must be matched to consider the object a match or if any metadata matches at all constitute a match.
See Also

Reference