DeveelDB  20151217
complete SQL database system, primarly developed for .NET/Mono frameworks
Public Member Functions | Package Functions | Properties | Private Member Functions | List of all members
Deveel.Data.Protocol.QueryResultColumn Class Reference

Public Member Functions

void SetUnique ()
 Sets this column to unique. More...
 
override bool Equals (Object ob)
 
override int GetHashCode ()
 

Package Functions

 QueryResultColumn (string name, ColumnInfo columnInfo)
 

Properties

string Name [get, private set]
 Returns the name of the field. More...
 
SqlType Type [get, private set]
 
bool IsNumericType [get]
 Returns true if this column is a numeric type. More...
 
int Size [get]
 Returns the size of the given field. This is only applicable to a few of the types, ie VARCHAR. More...
 
int Scale [get]
 If this is a number, gets or sets the scale of the field. More...
 
bool IsNotNull [get, private set]
 Determines whether the field can contain a null value or not. More...
 
bool IsUnique [get, private set]
 Determines whether the field can contain two items that are identical. More...
 
int UniqueGroup [get, set]
 Gets or sets the unique group this column is input or -1 if it does not belong to a unique group. More...
 
bool IsAliased [get]
 
Type RuntimeType [get]
 
Type ValueType [get]
 

Private Member Functions

 QueryResultColumn (string name, SqlType type, bool notNull)
 The Constructors if the type does require a size. More...
 

Detailed Description

Definition at line 25 of file QueryResultColumn.cs.

Constructor & Destructor Documentation

Deveel.Data.Protocol.QueryResultColumn.QueryResultColumn ( string  name,
SqlType  type,
bool  notNull 
)
inlineprivate

The Constructors if the type does require a size.

Parameters
name
type
notNull

Definition at line 32 of file QueryResultColumn.cs.

32  {
33  Name = name;
34  Type = type;
35  IsNotNull = notNull;
36  IsUnique = false;
37  UniqueGroup = -1;
38  }
int UniqueGroup
Gets or sets the unique group this column is input or -1 if it does not belong to a unique group...
bool IsUnique
Determines whether the field can contain two items that are identical.
string Name
Returns the name of the field.
bool IsNotNull
Determines whether the field can contain a null value or not.
Deveel.Data.Protocol.QueryResultColumn.QueryResultColumn ( string  name,
ColumnInfo  columnInfo 
)
inlinepackage

Definition at line 40 of file QueryResultColumn.cs.

41  : this(name, columnInfo.ColumnType, columnInfo.IsNotNull) {
42 
43  }
bool IsNotNull
Gets or sets a boolean value indicating if the column values are constrained to be ony NOT NULL...
Definition: ColumnInfo.cs:144
SqlType ColumnType
Gets the SqlType that cells within a table for this column will handle.
Definition: ColumnInfo.cs:99

Member Function Documentation

override bool Deveel.Data.Protocol.QueryResultColumn.Equals ( Object  ob)
inline

Definition at line 131 of file QueryResultColumn.cs.

131  {
132  var cd = (QueryResultColumn)ob;
133  return (Name.Equals(cd.Name) &&
134  Type == cd.Type &&
135  Size == cd.Size &&
136  IsNotNull == cd.IsNotNull &&
137  IsUnique == cd.IsUnique &&
138  UniqueGroup == cd.UniqueGroup);
139  }
int UniqueGroup
Gets or sets the unique group this column is input or -1 if it does not belong to a unique group...
QueryResultColumn(string name, SqlType type, bool notNull)
The Constructors if the type does require a size.
int Size
Returns the size of the given field. This is only applicable to a few of the types, ie VARCHAR.
bool IsUnique
Determines whether the field can contain two items that are identical.
string Name
Returns the name of the field.
bool IsNotNull
Determines whether the field can contain a null value or not.
override int Deveel.Data.Protocol.QueryResultColumn.GetHashCode ( )
inline

Definition at line 141 of file QueryResultColumn.cs.

141  {
142  return base.GetHashCode();
143  }
void Deveel.Data.Protocol.QueryResultColumn.SetUnique ( )
inline

Sets this column to unique.

Note: This can only happen during the setup of the object. Unpredictable results will occur otherwise.

Definition at line 52 of file QueryResultColumn.cs.

52  {
53  IsUnique = true;
54  }
bool IsUnique
Determines whether the field can contain two items that are identical.

Property Documentation

bool Deveel.Data.Protocol.QueryResultColumn.IsAliased
get

Definition at line 118 of file QueryResultColumn.cs.

bool Deveel.Data.Protocol.QueryResultColumn.IsNotNull
getprivate set

Determines whether the field can contain a null value or not.

Returns true if it is required for the column to contain data.

Definition at line 98 of file QueryResultColumn.cs.

bool Deveel.Data.Protocol.QueryResultColumn.IsNumericType
get

Returns true if this column is a numeric type.

Definition at line 71 of file QueryResultColumn.cs.

bool Deveel.Data.Protocol.QueryResultColumn.IsUnique
getprivate set

Determines whether the field can contain two items that are identical.

Returns true if each element must be unique.

Definition at line 106 of file QueryResultColumn.cs.

string Deveel.Data.Protocol.QueryResultColumn.Name
getprivate set

Returns the name of the field.

The field type returned should be ZIP or Address1. To resolve to the tables type, we must append an additional Company. or Customer. string to the front.

Definition at line 64 of file QueryResultColumn.cs.

Type Deveel.Data.Protocol.QueryResultColumn.RuntimeType
get

Definition at line 122 of file QueryResultColumn.cs.

int Deveel.Data.Protocol.QueryResultColumn.Scale
get

If this is a number, gets or sets the scale of the field.

Returns

Definition at line 88 of file QueryResultColumn.cs.

int Deveel.Data.Protocol.QueryResultColumn.Size
get

Returns the size of the given field. This is only applicable to a few of the types, ie VARCHAR.

Definition at line 80 of file QueryResultColumn.cs.

SqlType Deveel.Data.Protocol.QueryResultColumn.Type
getprivate set

Definition at line 66 of file QueryResultColumn.cs.

int Deveel.Data.Protocol.QueryResultColumn.UniqueGroup
getset

Gets or sets the unique group this column is input or -1 if it does not belong to a unique group.

Note: This can only happen during the setup of the object. Unpredictable results will occur otherwise.

Definition at line 116 of file QueryResultColumn.cs.

Type Deveel.Data.Protocol.QueryResultColumn.ValueType
get

Definition at line 126 of file QueryResultColumn.cs.


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