ParameterExpression

Overview

This class is an implementation of ParameterExpression and is used to represent parameters in Dynamic Where expressions.

This is one of the classes used to dynamically build WHERE statements from code.

For example, a WHERE clause of this query

SELECT * FROM Orders WHERE Customer = :CustomerID

represented using ParameterExpression would look like this: 

WhereExpression lResult;
lResult = new BinaryExpression(
              new FieldExpression("Customer"),
              new ParameterExpression("CustomerID", DataType.Integer, 0),
              BinaryOperator.Equal);

Location


 

constructor

Creates a new instance of the ParameterExpression class.

 

constructor

 

ParameterExpression()

constructor (String, DataType, Integer)

Creates a new instance of the ParameterExpression class with a specified name, type and size of the parameter.

 

constructor(aName: String; aType: DataType; aSize: Integer)

 

ParameterExpression(String aName, DataType aType, Integer aSize)

Parameters:

  • aName: The name of the parameter.
  • aType: The data type of the parameter.
  • aSize: The size of the parameter; used if applicable to the type.

Creates a new BinaryExpression from the given aLeft and aRight operands using BinaryOperator.

 

class method combine(aLeft: WhereExpression; aRight: WhereExpression): WhereExpression

 

static WhereExpression combine(WhereExpression aLeft, WhereExpression aRight)

Parameters:

  • aLeft: The left operand to be combined.
  • aRight: The right operand to be combined.

Creates a new BinaryExpression from the given aLeft and aRight operands using the given operator.

 

class method combine(aLeft: WhereExpression; aRight: WhereExpression; anOperator: BinaryOperator): WhereExpression

 

static WhereExpression combine(WhereExpression aLeft, WhereExpression aRight, BinaryOperator anOperator)

Parameters:

  • aLeft: The left operand to be combined.
  • aRight: The right operand to be combined.
  • anOperator: The operator to be used in combining.

fromString    (declared in WhereExpression)

Creates a new WhereExpression from the specified string, which should contain XML node in the correct Dynamic Where XML Format.

 

class method fromString(anXml: String): WhereExpression

 

static WhereExpression fromString(String anXml)

Parameters:

  • anXml: The given XML string.

fromStringToSql    (declared in WhereExpression)

A helper method to convert a XML string into SQL string.

 

class method fromStringToSql(anXml: String): String

 

static String fromStringToSql(String anXml)

Parameters:

  • anXml: The XML string to be converted.

fromXmlNode    (declared in WhereExpression)

Creates a new WhereExpression from the given XML node, which should be in the correct Dynamic Where XML Format.

 

class method fromXmlNode(aNode: Node): WhereExpression

 

static WhereExpression fromXmlNode(Node aNode)

Parameters:

  • aNode: The XML node to be parsed.

Kind

 

property Kind: WhereKind read;

 

WhereKind Kind { __get; }

ParameterName

 

property ParameterName: String read write;

 

String ParameterName { __get; __set; }

parseExpression    (declared in WhereExpression)

 

class method parseExpression(node: Node): WhereExpression

 

static WhereExpression parseExpression(Node node)

Parameters:

  • node:

readFromXml

Fills ParameterExpression with data from the given xml node, that should be in the correct Dynamic Where XML Format.

 

method readFromXml(aNode: Node)

 

void readFromXml(Node aNode)

Parameters:

  • aNode: The XML node that contains serialized ParameterExpression.

Size

 

property Size: Integer read write;

 

Integer Size { __get; __set; }

toSqlString    (declared in WhereExpression)

A helper method that wraps the similar one with the string builder and returns a SQL string.

 

method toSqlString: String

 

String toSqlString()

toSqlString (StringBuilder)

Creates an SQL representation of current ParameterExpression instance and appends it to the provided StringBuilder.

For example, this method call

(new ParameterExpression("Date")).ToSQLString(someStringBuilder)

would append the string ":Date" to someStringBuilder.

 

method toSqlString(aDestination: StringBuilder)

 

void toSqlString(StringBuilder aDestination)

Parameters:

  • aDestination: The destination string builder that will contain the string representation of the parameter.

toString    (declared in WhereExpression)

Returns a SQL string representation of the current expression.

 

method toString: String

 

String toString()

toXmlNode    (declared in WhereExpression)

Creates a query node (in the Dynamic Where XML Format) from the current expression.

 

method toXmlNode: Node

 

Node toXmlNode()

toXmlString    (declared in WhereExpression)

Creates the query node (in the Dynamic Where XML Format) from current expression and returns it in the string format.

 

method toXmlString: String

 

String toXmlString()

Type

 

property Type: DataType read write;

 

DataType Type { __get; __set; }

validate    (declared in WhereExpression)

Validates the current expression with the WhereValidator and returns TRUE if it contains no errors. The main purpose of the validation is to scan all objects of WhereExpession tree and make sure that they contain correct field names.

 

method validate: Boolean

 

Boolean validate()

validate (WhereExpression): Boolean    (declared in WhereExpression)

Validates the provided WhereExpression with the WhereValidator and returns TRUE if it contains no errors. The main purpose of the validation is to scan all objects of WhereExpession tree and make sure that it contains correct field names.

 

class method validate(anExpression: WhereExpression): Boolean

 

static Boolean validate(WhereExpression anExpression)

Parameters:

  • anExpression: The expression to be validated.

writeToXml

Creates Xml node (in the Dynamic Where XML Format) from current ParameterExpression and appends it to the given parent node.

 

method writeToXml(aNode: Node)

 

void writeToXml(Node aNode)

Parameters:

  • aNode: The parent XML node.

 

Kind

 

property Kind: WhereKind read;

 

WhereKind Kind { __get; }

ParameterName

 

property ParameterName: String read write;

 

String ParameterName { __get; __set; }

Size

 

property Size: Integer read write;

 

Integer Size { __get; __set; }

Type

 

property Type: DataType read write;

 

DataType Type { __get; __set; }

 

Creates a new BinaryExpression from the given aLeft and aRight operands using BinaryOperator.

 

class method combine(aLeft: WhereExpression; aRight: WhereExpression): WhereExpression

 

static WhereExpression combine(WhereExpression aLeft, WhereExpression aRight)

Parameters:

  • aLeft: The left operand to be combined.
  • aRight: The right operand to be combined.

Creates a new BinaryExpression from the given aLeft and aRight operands using the given operator.

 

class method combine(aLeft: WhereExpression; aRight: WhereExpression; anOperator: BinaryOperator): WhereExpression

 

static WhereExpression combine(WhereExpression aLeft, WhereExpression aRight, BinaryOperator anOperator)

Parameters:

  • aLeft: The left operand to be combined.
  • aRight: The right operand to be combined.
  • anOperator: The operator to be used in combining.

fromString    (declared in WhereExpression)

Creates a new WhereExpression from the specified string, which should contain XML node in the correct Dynamic Where XML Format.

 

class method fromString(anXml: String): WhereExpression

 

static WhereExpression fromString(String anXml)

Parameters:

  • anXml: The given XML string.

fromStringToSql    (declared in WhereExpression)

A helper method to convert a XML string into SQL string.

 

class method fromStringToSql(anXml: String): String

 

static String fromStringToSql(String anXml)

Parameters:

  • anXml: The XML string to be converted.

fromXmlNode    (declared in WhereExpression)

Creates a new WhereExpression from the given XML node, which should be in the correct Dynamic Where XML Format.

 

class method fromXmlNode(aNode: Node): WhereExpression

 

static WhereExpression fromXmlNode(Node aNode)

Parameters:

  • aNode: The XML node to be parsed.

parseExpression    (declared in WhereExpression)

 

class method parseExpression(node: Node): WhereExpression

 

static WhereExpression parseExpression(Node node)

Parameters:

  • node:

validate (WhereExpression): Boolean    (declared in WhereExpression)

Validates the provided WhereExpression with the WhereValidator and returns TRUE if it contains no errors. The main purpose of the validation is to scan all objects of WhereExpession tree and make sure that it contains correct field names.

 

class method validate(anExpression: WhereExpression): Boolean

 

static Boolean validate(WhereExpression anExpression)

Parameters:

  • anExpression: The expression to be validated.

 

constructor

Creates a new instance of the ParameterExpression class.

 

constructor

 

ParameterExpression()

constructor (String, DataType, Integer)

Creates a new instance of the ParameterExpression class with a specified name, type and size of the parameter.

 

constructor(aName: String; aType: DataType; aSize: Integer)

 

ParameterExpression(String aName, DataType aType, Integer aSize)

Parameters:

  • aName: The name of the parameter.
  • aType: The data type of the parameter.
  • aSize: The size of the parameter; used if applicable to the type.

readFromXml

Fills ParameterExpression with data from the given xml node, that should be in the correct Dynamic Where XML Format.

 

method readFromXml(aNode: Node)

 

void readFromXml(Node aNode)

Parameters:

  • aNode: The XML node that contains serialized ParameterExpression.

toSqlString    (declared in WhereExpression)

A helper method that wraps the similar one with the string builder and returns a SQL string.

 

method toSqlString: String

 

String toSqlString()

toSqlString (StringBuilder)

Creates an SQL representation of current ParameterExpression instance and appends it to the provided StringBuilder.

For example, this method call

(new ParameterExpression("Date")).ToSQLString(someStringBuilder)

would append the string ":Date" to someStringBuilder.

 

method toSqlString(aDestination: StringBuilder)

 

void toSqlString(StringBuilder aDestination)

Parameters:

  • aDestination: The destination string builder that will contain the string representation of the parameter.

toString    (declared in WhereExpression)

Returns a SQL string representation of the current expression.

 

method toString: String

 

String toString()

toXmlNode    (declared in WhereExpression)

Creates a query node (in the Dynamic Where XML Format) from the current expression.

 

method toXmlNode: Node

 

Node toXmlNode()

toXmlString    (declared in WhereExpression)

Creates the query node (in the Dynamic Where XML Format) from current expression and returns it in the string format.

 

method toXmlString: String

 

String toXmlString()

validate    (declared in WhereExpression)

Validates the current expression with the WhereValidator and returns TRUE if it contains no errors. The main purpose of the validation is to scan all objects of WhereExpession tree and make sure that they contain correct field names.

 

method validate: Boolean

 

Boolean validate()

writeToXml

Creates Xml node (in the Dynamic Where XML Format) from current ParameterExpression and appends it to the given parent node.

 

method writeToXml(aNode: Node)

 

void writeToXml(Node aNode)

Parameters:

  • aNode: The parent XML node.