Module com.darkcollective.relix.ast

Package com.darkcollective.relix.ast

Record Class CollateOperand

java.lang.Object

java.lang.Record

com.darkcollective.relix.ast.CollateOperand

Record Components:

operand - the string being compared; must not be null

collation - the collation's name: BINARY, NOCASE or a locale tag; must not be blank

location - the source location of this operand; never null

All Implemented Interfaces:

Operand

public record CollateOperand(Operand operand, String collation, SourceLocation location)
extends Record
implements Operand

A string compared under a named collation: s COLLATE NOCASE.

The operand's value is unchanged; the collation decides how it compares with another string. It applies where a comparison is made: in a comparison, a membership or pattern test, a join condition, a sort key and a grouping key.

BINARY compares by code point, which is what every string comparison does without a collation. NOCASE compares strings equal when they are equal lower-cased. Any other name is a locale, such as 'en-US', which orders strings as that language's dictionary does. Names are held as written, the two built-in ones upper-cased; whether a name is a locale the engine has is decided at analysis.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINARY	Code-point order, the default.
static final String	NOCASE	Equal when equal lower-cased.

Constructor Summary

Constructors

Constructor	Description
CollateOperand(Operand operand, String collation)	Convenience constructor for tests; uses SourceLocation.UNKNOWN.
CollateOperand(Operand operand, String collation, SourceLocation location)	Creates an instance of a CollateOperand record class.

Method Summary

Modifier and Type	Method	Description
<R> R	accept(OperandVisitor<R> visitor)
String	collation()	Returns the value of the collation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isLocale()	Returns whether the collation is a locale rather than BINARY or NOCASE.
SourceLocation	location()	Returns the value of the location record component.
Operand	operand()	Returns the value of the operand record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.darkcollective.relix.ast.Operand

prettyPrint, prettyPrint

Field Details

BINARY

public static final String BINARY

Code-point order, the default.

See Also:

• Constant Field Values

NOCASE

public static final String NOCASE

Equal when equal lower-cased.

See Also:

• Constant Field Values

Constructor Details

CollateOperand

public CollateOperand(Operand operand,
 String collation,
 SourceLocation location)

Creates an instance of a CollateOperand record class.

Parameters:

operand - the value for the operand record component

collation - the value for the collation record component

location - the value for the location record component

CollateOperand

public CollateOperand(Operand operand,
 String collation)

Convenience constructor for tests; uses SourceLocation.UNKNOWN.

Method Details

isLocale

public boolean isLocale()

Returns whether the collation is a locale rather than BINARY or NOCASE.

Returns:

whether the collation is a locale rather than BINARY or NOCASE

accept

public <R> R accept(OperandVisitor<R> visitor)

Specified by:

accept in interface Operand

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

operand

public Operand operand()

Returns the value of the operand record component.

Returns:

the value of the operand record component

collation

public String collation()

Returns the value of the collation record component.

Returns:

the value of the collation record component

location

public SourceLocation location()

Returns the value of the location record component.

Specified by:

location in interface Operand

Returns:

the value of the location record component