BetweenExpression

Overview

The BetweenExpression class implements BetweenExpression that checks belonging to a range of values.

This is one of the classes used to dynamically build WHERE statements from code (Dynamic Where feature of Data Abstract).

For example, a WHERE clause of this query

SELECT * FROM Customers WHERE CustomerId between 5000 AND 5010;

will be presented as:

WhereExpression lResult;
lResult = new BetweenExpression(
              new FieldExpression("CustomerId"),
              new ConstantExpression("5000", DataType.Integer),
              new ConstantExpression("5010", DataType.Integer));

Location

 

constructor

Creates an instance of BetweenExpression.

 

constructor

 

BetweenExpression()

Creates an instance of BetweenExpression with the given middle expression and the specified lower and upper bounds of the range.

 

constructor(anExpression: WhereExpression; aLower: WhereExpression; aUpper: WhereExpression)

 

BetweenExpression(WhereExpression anExpression, WhereExpression aLower, WhereExpression aUpper)

Parameters:

  • anExpression: The given expression in the middle.
  • aLower: The given lower bound expression.
  • aUpper: The given upper bound expression.

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.

Expression

Represents datapoint expression (for example, field name) in current between expression.

 

property Expression: WhereExpression read write;

 

WhereExpression Expression { __get; __set; }

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; }

Lower

Represents lower value of the current between expression.

 

property Lower: WhereExpression read write;

 

WhereExpression Lower { __get; __set; }

parseExpression    (declared in WhereExpression)

 

class method parseExpression(node: Node): WhereExpression

 

static WhereExpression parseExpression(Node node)

Parameters:

  • node:

readFromXml

Initializes the current BetweenExpression from the given XML node.

 

method readFromXml(aNode: Node)

 

void readFromXml(Node aNode)

Parameters:

  • aNode: The node that contains the serialized expression.

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)    (declared in WhereExpression)

Creates an SQL representation of thу current where expression instance and appends it to the provided StringBuilder.

 

method toSqlString(aDestination: StringBuilder)

 

void toSqlString(StringBuilder aDestination)

Parameters:

  • aDestination: The destination string builder to be appended.

toSqlString (StringBuilder)

Creates an SQL representation of the between expression and appends it to the provided StringBuilder.

 

method toSqlString(destination: StringBuilder)

 

void toSqlString(StringBuilder destination)

Parameters:

  • destination: The destination string builder that will contain the string representation of the between expression.

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()

Upper

Represents upper value of the current between expression.

 

property Upper: WhereExpression read write;

 

WhereExpression Upper { __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 the current BetweenExpression and appends it to the given parent node.

 

method writeToXml(aNode: Node)

 

void writeToXml(Node aNode)

Parameters:

  • aNode: The parent XML node.

 

Expression

Represents datapoint expression (for example, field name) in current between expression.

 

property Expression: WhereExpression read write;

 

WhereExpression Expression { __get; __set; }

Kind

 

property Kind: WhereKind read;

 

WhereKind Kind { __get; }

Lower

Represents lower value of the current between expression.

 

property Lower: WhereExpression read write;

 

WhereExpression Lower { __get; __set; }

Upper

Represents upper value of the current between expression.

 

property Upper: WhereExpression read write;

 

WhereExpression Upper { __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 an instance of BetweenExpression.

 

constructor

 

BetweenExpression()

Creates an instance of BetweenExpression with the given middle expression and the specified lower and upper bounds of the range.

 

constructor(anExpression: WhereExpression; aLower: WhereExpression; aUpper: WhereExpression)

 

BetweenExpression(WhereExpression anExpression, WhereExpression aLower, WhereExpression aUpper)

Parameters:

  • anExpression: The given expression in the middle.
  • aLower: The given lower bound expression.
  • aUpper: The given upper bound expression.

readFromXml

Initializes the current BetweenExpression from the given XML node.

 

method readFromXml(aNode: Node)

 

void readFromXml(Node aNode)

Parameters:

  • aNode: The node that contains the serialized expression.

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)    (declared in WhereExpression)

Creates an SQL representation of thу current where expression instance and appends it to the provided StringBuilder.

 

method toSqlString(aDestination: StringBuilder)

 

void toSqlString(StringBuilder aDestination)

Parameters:

  • aDestination: The destination string builder to be appended.

toSqlString (StringBuilder)

Creates an SQL representation of the between expression and appends it to the provided StringBuilder.

 

method toSqlString(destination: StringBuilder)

 

void toSqlString(StringBuilder destination)

Parameters:

  • destination: The destination string builder that will contain the string representation of the between expression.

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 the current BetweenExpression and appends it to the given parent node.

 

method writeToXml(aNode: Node)

 

void writeToXml(Node aNode)

Parameters:

  • aNode: The parent XML node.