Deveel.Data.Sql.Tables.RowId Struct Reference

Defines the value of a ROWID object, that is a unique reference within a database system to a single row. More...

Inheritance diagram for Deveel.Data.Sql.Tables.RowId:

Public Member Functions
	RowId (int tableId, int rowNumber)
	Constructs the object with the references to the given table unique ID and the number of the row within the given table. More...
bool	Equals (RowId other)
override bool	Equals (object obj)
override int	GetHashCode ()
override string	ToString ()

Static Public Member Functions
static bool	TryParse (string s, out RowId value)
	Attempts to parse the input string given into a valid instance of RowId. More...
static RowId	Parse (string s)
	Parses the given input string into an instance of RowId. More...

Static Public Attributes
static readonly RowId	Null = new RowId(true)
	Gets a NULL instance of RowId. More...

Properties
int	TableId [get, private set]
	Gets the unique identifier of the table the row is contained. More...
int	RowNumber [get, private set]
	Gets the number of the column within the table referenced. More...
bool	IsNull [get, private set]
	Gets a boolean value indicating if the object equivales to a NULL. More...

Private Member Functions
	RowId (bool isNull)

Detailed Description

Defines the value of a ROWID object, that is a unique reference within a database system to a single row.

Definition at line 24 of file RowId.cs.

Constructor & Destructor Documentation

Deveel.Data.Sql.Tables.RowId.RowId ( int  tableId, int  rowNumber  )

inline

Constructs the object with the references to the given table unique ID and the number of the row within the given table.

Parameters

tableId	The table unique identifier with the database system.
rowNumber	The number of the row within the table. This value is always unique, also after the row is removed.

Definition at line 39 of file RowId.cs.

            : this(false) {
            RowNumber = rowNumber;
            TableId = tableId;
        }

Deveel.Data.Sql.Tables.RowId.RowId ( bool  isNull )

inlineprivate

Definition at line 45 of file RowId.cs.

            : this() {
            IsNull = isNull;
        }

Member Function Documentation

bool Deveel.Data.Sql.Tables.RowId.Equals ( RowId  other )

inline

Definition at line 66 of file RowId.cs.

                                        {
            if (IsNull && other.IsNull)
                return true;

            return TableId.Equals(other.TableId) &&
                   RowNumber.Equals(other.RowNumber);
        }

override bool Deveel.Data.Sql.Tables.RowId.Equals ( object  obj )

inline

Definition at line 74 of file RowId.cs.

                                                {
            if (!(obj is RowId))
                return false;

            return Equals((RowId) obj);
        }

override int Deveel.Data.Sql.Tables.RowId.GetHashCode ( )

inline

Definition at line 81 of file RowId.cs.

                                          {
            if (IsNull)
                return 0;

            return unchecked (TableId.GetHashCode() ^ RowNumber.GetHashCode());
        }

static RowId Deveel.Data.Sql.Tables.RowId.Parse ( string  s )

inlinestatic

Parses the given input string into an instance of RowId.

Parameters

s	The input string to parse.

Returns

Returns a new instance of RowId as a result of the parse of the input string.

Exceptions

FormatException

If the format of the input string is invalid.

Definition at line 138 of file RowId.cs.

                                            {
            RowId rowId;
            if (!TryParse(s, out rowId))
                throw new FormatException("Unable to parse the given string into a valid ROWID.");

            return rowId;
        }

override string Deveel.Data.Sql.Tables.RowId.ToString ( )

inline

Definition at line 88 of file RowId.cs.

                                          {
            return String.Format("{0}-{1}", TableId, RowNumber);
        }

static bool Deveel.Data.Sql.Tables.RowId.TryParse ( string  s, out RowId  value  )

inlinestatic

Attempts to parse the input string given into a valid instance of RowId.

Parameters

s	The input string to parse.
value	The out value from the parse.

Returns

Returns true if the string was succesfully parsed into a RowId, otherwise false.

See also

ToString

Definition at line 103 of file RowId.cs.

                                                               {
            value = Null;

            if (String.IsNullOrEmpty(s))
                return false;

            var index = s.IndexOf("-", StringComparison.Ordinal);
            if (index == -1)
                return false;

            var s1 = s.Substring(0, index);
            var s2 = s.Substring(index + 1);

            int v1;
            int v2;
            if (!Int32.TryParse(s1, out v1))
                return false;
            if (!Int32.TryParse(s2, out v2))
                return false;

            value = new RowId(v1, v2);
            return true;
        }

Member Data Documentation

readonly RowId Deveel.Data.Sql.Tables.RowId.Null = new RowId(true)

static

Gets a NULL instance of RowId.

Definition at line 28 of file RowId.cs.

Property Documentation

bool Deveel.Data.Sql.Tables.RowId.IsNull

getprivate set

Gets a boolean value indicating if the object equivales to a NULL.

Definition at line 64 of file RowId.cs.

int Deveel.Data.Sql.Tables.RowId.RowNumber

getprivate set

Gets the number of the column within the table referenced.

Definition at line 58 of file RowId.cs.

int Deveel.Data.Sql.Tables.RowId.TableId

getprivate set

Gets the unique identifier of the table the row is contained.

Definition at line 53 of file RowId.cs.

---

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

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Sql.Tables/RowId.cs