Deveel.Data.Index.IndexRange Struct Reference

Describes the range of values to select from an index. More...

Public Member Functions
	IndexRange (RangeFieldOffset startOffset, DataObject firstValue, RangeFieldOffset lastOffset, DataObject endValue)
	Constructs the range given a start and an end location More...
override bool	Equals (object obj)
override int	GetHashCode ()
override string	ToString ()

Static Public Member Functions
static bool	operator== (IndexRange a, IndexRange b)
static bool	operator!= (IndexRange a, IndexRange b)

Static Public Attributes
static readonly DataObject	FirstInSet = new DataObject(PrimitiveTypes.Null(), new SqlString("FirstInSet"))
static readonly DataObject	LastInSet = new DataObject(PrimitiveTypes.Null(), new SqlString("LastInSet"))
static readonly IndexRange	FullRange
	The entire range of values in an index (including NULL) More...
static readonly IndexRange	FullRangeNotNull
	The entire range of values in an index (not including NULL) More...
static readonly IndexRange	Null = new IndexRange(true)

Properties
bool	IsNull [get, private set]
RangeFieldOffset	StartOffset [get, private set]
	Gets the offset of the first value of the range. More...
DataObject	StartValue [get, private set]
	Gets the first value of the range. More...
RangeFieldOffset	EndOffset [get, private set]
	Gets the offset of the last value of the range. More...
DataObject	EndValue [get, private set]
	Gets the last value of the range. More...

Private Member Functions
	IndexRange (bool isNull)

Detailed Description

Describes the range of values to select from an index.

A range has a start value, an end value, and whether we should pick inclusive or exclusive of the end value. The start value may be a concrete value from the set or it may be a flag that represents the start or end of the list.

Note that the the start value may not compare less than the end value. For example, start can not be RangeFieldOffset.LastValue and end can not be RangeFieldOffset.FirstValue.

Definition at line 38 of file IndexRange.cs.

Constructor & Destructor Documentation

Deveel.Data.Index.IndexRange.IndexRange ( RangeFieldOffset  startOffset, DataObject  firstValue, RangeFieldOffset  lastOffset, DataObject  endValue  )

inline

Constructs the range given a start and an end location

Parameters

startOffset	The offset of the first value of the range.
firstValue	The first value of the range
lastOffset	The offset within the range of the last value.
endValue	The last value of the range.

Definition at line 56 of file IndexRange.cs.

            : this(false) {
            StartOffset = startOffset;
            StartValue = firstValue;
            EndOffset = lastOffset;
            EndValue = endValue;
        }

Deveel.Data.Index.IndexRange.IndexRange ( bool  isNull )

inlineprivate

Definition at line 64 of file IndexRange.cs.

            : this() {
            IsNull = isNull;
        }

Member Function Documentation

override bool Deveel.Data.Index.IndexRange.Equals ( object  obj )

inline

Definition at line 106 of file IndexRange.cs.

                                                {
            var destRange = (IndexRange)obj;
            if (IsNull && destRange.IsNull)
                return true;
            if (IsNull && !destRange.IsNull)
                return false;
            if (!IsNull && destRange.IsNull)
                return false;

            return (StartValue.Value.Equals(destRange.StartValue.Value) &&
                    EndValue.Value.Equals(destRange.EndValue.Value) &&
                    StartOffset == destRange.StartOffset &&
                    EndOffset == destRange.EndOffset);
        }

override int Deveel.Data.Index.IndexRange.GetHashCode ( )

inline

Definition at line 122 of file IndexRange.cs.

                                          {
            return base.GetHashCode();
        }

static bool Deveel.Data.Index.IndexRange.operator!= ( IndexRange  a, IndexRange  b  )

inlinestatic

Definition at line 150 of file IndexRange.cs.

                                                                   {
            return !(a == b);
        }

static bool Deveel.Data.Index.IndexRange.operator== ( IndexRange  a, IndexRange  b  )

inlinestatic

Definition at line 146 of file IndexRange.cs.

                                                                   {
            return a.Equals(b);
        }

override string Deveel.Data.Index.IndexRange.ToString ( )

inline

Definition at line 127 of file IndexRange.cs.

                                          {
            var sb = new StringBuilder();
            if (StartOffset == RangeFieldOffset.FirstValue) {
                sb.Append("FIRST_VALUE ");
            } else if (StartOffset == RangeFieldOffset.AfterLastValue) {
                sb.Append("AFTER_LAST_VALUE ");
            }

            sb.Append(StartValue.ToString());
            sb.Append(" -> ");
            if (EndOffset == RangeFieldOffset.LastValue) {
                sb.Append("LAST_VALUE ");
            } else if (EndOffset == RangeFieldOffset.BeforeFirstValue) {
                sb.Append("BEFORE_FIRST_VALUE ");
            }
            sb.Append(EndValue.ToString());
            return sb.ToString();
        }

Member Data Documentation

readonly DataObject Deveel.Data.Index.IndexRange.FirstInSet = new DataObject(PrimitiveTypes.Null(), new SqlString("FirstInSet"))

static

Definition at line 42 of file IndexRange.cs.

readonly IndexRange Deveel.Data.Index.IndexRange.FullRange

static

Initial value:

= new IndexRange(RangeFieldOffset.FirstValue, FirstInSet,
            RangeFieldOffset.LastValue, LastInSet)

The entire range of values in an index (including NULL)

Definition at line 74 of file IndexRange.cs.

readonly IndexRange Deveel.Data.Index.IndexRange.FullRangeNotNull

static

Initial value:

= new IndexRange(RangeFieldOffset.AfterLastValue, DataObject.Null(),
            RangeFieldOffset.LastValue, LastInSet)

The entire range of values in an index (not including NULL)

Definition at line 80 of file IndexRange.cs.

readonly DataObject Deveel.Data.Index.IndexRange.LastInSet = new DataObject(PrimitiveTypes.Null(), new SqlString("LastInSet"))

static

Definition at line 47 of file IndexRange.cs.

readonly IndexRange Deveel.Data.Index.IndexRange.Null = new IndexRange(true)

static

Definition at line 83 of file IndexRange.cs.

Property Documentation

RangeFieldOffset Deveel.Data.Index.IndexRange.EndOffset

getprivate set

Gets the offset of the last value of the range.

Definition at line 98 of file IndexRange.cs.

DataObject Deveel.Data.Index.IndexRange.EndValue

getprivate set

Gets the last value of the range.

Definition at line 103 of file IndexRange.cs.

bool Deveel.Data.Index.IndexRange.IsNull

getprivate set

Definition at line 69 of file IndexRange.cs.

RangeFieldOffset Deveel.Data.Index.IndexRange.StartOffset

getprivate set

Gets the offset of the first value of the range.

Definition at line 88 of file IndexRange.cs.

DataObject Deveel.Data.Index.IndexRange.StartValue

getprivate set

Gets the first value of the range.

Definition at line 93 of file IndexRange.cs.

---

The documentation for this struct was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Index/IndexRange.cs