Deveel.Data.Sql.ObjectName Class Reference

Describes the name of an object within a database. More...

Inheritance diagram for Deveel.Data.Sql.ObjectName:

Public Member Functions
	ObjectName (string name)
	Constructs a name reference without a parent. More...
	ObjectName (ObjectName parent, string name)
	Constructs a name reference with a given parent. More...
ObjectName	Child (string name)
	Creates a reference what is the child of the current one. More...
ObjectName	Child (ObjectName childName)
int	CompareTo (ObjectName other)
	Compares this instance of the object reference to a given one and returns a value indicating if the two instances equivales. More...
override string	ToString ()
override bool	Equals (object obj)
bool	Equals (ObjectName other)
bool	Equals (ObjectName other, bool ignoreCase)
	Compares this object name with the other one given, according to the case sensitivity specified. More...
override int	GetHashCode ()

Static Public Member Functions
static ObjectName	Parse (string s)
	Parses the given string into a ObjectName object. More...
static ObjectName	ResolveSchema (string schemaName, string name)
	Creates a new reference to a table, given a schema and a table name. More...
static void	Serialize (ObjectName objectName, Stream stream)
static void	Serialize (ObjectName objectName, BinaryWriter writer)
static ObjectName	Deserialize (Stream stream)
static ObjectName	Deserialize (BinaryReader reader)

Public Attributes
const string	GlobName = "*"
	The special name used as a wild-card to indicate all the columns of a table must be referenced in a given context. More...
const char	Separator = '.'
	The character that separates a name from its parent or child. More...

Properties
ObjectName	Parent [get, private set]
	Gets the parent reference of the current one, if any or null if none. More...
string	ParentName [get]
string	Name [get, private set]
	Gets the name of the object being referenced. More...
string	FullName [get]
	Gets the full reference name formatted. More...
bool	IsGlob [get]
	Indicates if this reference equivales to GlobName. More...

Private Member Functions
	ObjectName (ObjectData graph)
void ISerializable.	GetData (SerializeData graph)

Detailed Description

Describes the name of an object within a database.

The name of an object is composed by multiple parts, depending on the level of nesting of the object this name references.

For example, a reference to a table will be composed by the name of the schema and the name of the table: Schema.Table, while a reference to a column will be composed by the name of the schema, the name of the parent table and the name of the column itself: Schema.Table.Column.

Depending on the xecution context, parts of the name can be omitted and will be resolved at run-time.

Definition at line 44 of file ObjectName.cs.

Constructor & Destructor Documentation

Deveel.Data.Sql.ObjectName.ObjectName ( string  name )

inline

Constructs a name reference without a parent.

Parameters

name	The object name.

NOTE: This constructor is intended to be handling a name with no parent: if the string provided as name contains any Separator character, this will make the resolution to fail at run-time. User Parse method to obtain a reference tree.

Exceptions

ArgumentNullException

If name is null or empty.

See also

ObjectName(ObjectName, String)

Definition at line 71 of file ObjectName.cs.

            : this(null, name) {
        }

Deveel.Data.Sql.ObjectName.ObjectName ( ObjectName  parent, string  name  )

inline

Constructs a name reference with a given parent.

Parameters

parent	The parent reference of the one being constructed
name	The name of the object.

Exceptions

ArgumentNullException

If name is null or empty.

Definition at line 83 of file ObjectName.cs.

                                                          {
            if (String.IsNullOrEmpty(name))
                throw new ArgumentNullException("name");
            
            Name = name;
            Parent = parent;
        }

Deveel.Data.Sql.ObjectName.ObjectName ( ObjectData  graph )

inlineprivate

Definition at line 91 of file ObjectName.cs.

                                             {
            Name = graph.GetString("Name");
            Parent = graph.GetValue<ObjectName>("Parent");
        }

Member Function Documentation

ObjectName Deveel.Data.Sql.ObjectName.Child ( string  name )

inline

Creates a reference what is the child of the current one.

Parameters

name	The name of the child rerefence.

Returns

Returns an istance of ObjectName that has this one as parent, and is named by the given name .

Definition at line 189 of file ObjectName.cs.

                                             {
            return new ObjectName(this, name);
        }

ObjectName Deveel.Data.Sql.ObjectName.Child ( ObjectName  childName )

inline

Definition at line 193 of file ObjectName.cs.

                                                      {
            var baseName = this;
            ObjectName parent = childName.Parent;
            while (parent != null) {
                baseName = baseName.Child(parent.Name);
                parent = parent.Parent;
            }

            baseName = baseName.Child(childName.Name);
            return baseName;
        }

int Deveel.Data.Sql.ObjectName.CompareTo ( ObjectName  other )

inline

Compares this instance of the object reference to a given one and returns a value indicating if the two instances equivales.

Parameters

other

The other object reference to compare.

Returns

Definition at line 211 of file ObjectName.cs.

                                               {
            if (other == null)
                return -1;

            int v = 0;
            if (Parent != null)
                v = Parent.CompareTo(other.Parent);

            if (v == 0)
                v = String.Compare(Name, other.Name, StringComparison.Ordinal);

            return v;
        }

static ObjectName Deveel.Data.Sql.ObjectName.Deserialize ( Stream  stream )

inlinestatic

Definition at line 311 of file ObjectName.cs.

                                                            {
            using (var reader = new BinaryReader(stream, Encoding.Unicode)) {
                return Deserialize(reader);
            }
        }

static ObjectName Deveel.Data.Sql.ObjectName.Deserialize ( BinaryReader  reader )

inlinestatic

Definition at line 317 of file ObjectName.cs.

                                                                  {
            var status = reader.ReadByte();
            if (status == 0)
                return null;

            ObjectName parent = null;

            var parentStatus = reader.ReadByte();
            if (parentStatus == 1)
                parent = Deserialize(reader);

            var name = reader.ReadString();
            return new ObjectName(parent, name);
        }

override bool Deveel.Data.Sql.ObjectName.Equals ( object  obj )

inline

Definition at line 241 of file ObjectName.cs.

                                                {
            var other = obj as ObjectName;
            if (other == null)
                return false;

            return Equals(other);
        }

bool Deveel.Data.Sql.ObjectName.Equals ( ObjectName  other )

inline

Definition at line 249 of file ObjectName.cs.

                                             {
            return Equals(other, true);
        }

bool Deveel.Data.Sql.ObjectName.Equals ( ObjectName  other, bool  ignoreCase  )

inline

Compares this object name with the other one given, according to the case sensitivity specified.

Parameters

other	The other ObjectName to compare.
ignoreCase	The specification to either ignore the case for comparison.

Returns

Returns true if the two instances are equal, according to the case sensitivity given, or false otherwise.

Definition at line 263 of file ObjectName.cs.

                                                              {
            if (other == null)
                return false;

            if (Parent != null && other.Parent == null)
                return false;
            if (Parent == null && other.Parent != null)
                return false;

            if (Parent != null && !Parent.Equals(other.Parent, ignoreCase))
                return false;

            var comparison = ignoreCase ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal;
            return String.Equals(Name, other.Name, comparison);
        }

void ISerializable. Deveel.Data.Sql.ObjectName.GetData ( SerializeData  graph )

inlineprivate

Implements Deveel.Data.Serialization.ISerializable.

Definition at line 236 of file ObjectName.cs.

                                                        {
            graph.SetValue("Name", Name);
            graph.SetValue("Parent", Parent);
        }

override int Deveel.Data.Sql.ObjectName.GetHashCode ( )

inline

Definition at line 279 of file ObjectName.cs.

                                          {
            var code = Name.GetHashCode() ^ 5623;
            if (Parent != null)
                code ^= Parent.GetHashCode();

            return code;
        }

static ObjectName Deveel.Data.Sql.ObjectName.Parse ( string  s )

inlinestatic

Parses the given string into a ObjectName object.

Parameters

s	The string to parse

Returns

Returns an instance of ObjectName that is the result of parsing of the string given.

Exceptions

FormatException	If the given input string is of an invalid format.
ArgumentNullException	If the given string is null or empty.

Definition at line 139 of file ObjectName.cs.

                                                 {
            if (String.IsNullOrEmpty(s))
                throw new ArgumentNullException("s");

            var sp = s.Split(new[] {'.'}, StringSplitOptions.RemoveEmptyEntries);
            if (sp.Length == 0)
                throw new FormatException("At least one part of the name must be provided");

            if (sp.Length == 1)
                return new ObjectName(sp[0]);

            ObjectName finalName = null;
            for (int i = 0; i < sp.Length; i++) {
                if (finalName == null) {
                    finalName = new ObjectName(sp[i]);
                } else {
                    finalName = new ObjectName(finalName, sp[i]);
                }               
            }

            return finalName;
        }

static ObjectName Deveel.Data.Sql.ObjectName.ResolveSchema ( string  schemaName, string  name  )

inlinestatic

Creates a new reference to a table, given a schema and a table name.

Parameters

schemaName	The name of the schema that is the parent of the given table.
name	The name of the table to reference.

Returns

Returns an instance of ObjectName that references a table within the given schema.

Definition at line 172 of file ObjectName.cs.

                                                                               {
            var sb = new StringBuilder();
            if (!String.IsNullOrEmpty(schemaName))
                sb.Append(schemaName).Append('.');
            sb.Append(name);

            return Parse(sb.ToString());
        }

static void Deveel.Data.Sql.ObjectName.Serialize ( ObjectName  objectName, Stream  stream  )

inlinestatic

Definition at line 287 of file ObjectName.cs.

                                                                           {
            using (var writer = new BinaryWriter(stream, Encoding.Unicode)) {
                Serialize(objectName, writer);
            }
        }

static void Deveel.Data.Sql.ObjectName.Serialize ( ObjectName  objectName, BinaryWriter  writer  )

inlinestatic

Definition at line 293 of file ObjectName.cs.

                                                                                 {
            if (objectName == null) {
                writer.Write((byte) 0);
                return;
            }

            writer.Write((byte)1);

            if (objectName.Parent != null) {
                writer.Write((byte) 1);
                Serialize(objectName.Parent, writer);
            } else {
                writer.Write((byte)0);
            }

            writer.Write(objectName.Name);
        }

override string Deveel.Data.Sql.ObjectName.ToString ( )

inline

Definition at line 225 of file ObjectName.cs.

                                          {
            var sb = new StringBuilder();
            if (Parent != null) {
                sb.Append(Parent);
                sb.Append('.');
            }

            sb.Append(Name);
            return sb.ToString();
        }

Member Data Documentation

const string Deveel.Data.Sql.ObjectName.GlobName = "*"

The special name used as a wild-card to indicate all the columns of a table must be referenced in a given context.

Definition at line 49 of file ObjectName.cs.

const char Deveel.Data.Sql.ObjectName.Separator = '.'

The character that separates a name from its parent or child.

Definition at line 54 of file ObjectName.cs.

Property Documentation

string Deveel.Data.Sql.ObjectName.FullName

get

Gets the full reference name formatted.

See also

ToString()

Definition at line 114 of file ObjectName.cs.

bool Deveel.Data.Sql.ObjectName.IsGlob

get

Indicates if this reference equivales to GlobName.

Definition at line 121 of file ObjectName.cs.

string Deveel.Data.Sql.ObjectName.Name

getprivate set

Gets the name of the object being referenced.

Definition at line 108 of file ObjectName.cs.

ObjectName Deveel.Data.Sql.ObjectName.Parent

getprivate set

Gets the parent reference of the current one, if any or null if none.

Definition at line 99 of file ObjectName.cs.

string Deveel.Data.Sql.ObjectName.ParentName

get

Definition at line 101 of file ObjectName.cs.

---

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

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