This class defines the set of common index transformation (or collation) methods. More...

Inheritance diagram for Collation:

Static Public Member Functions
_.Library.String	AlphaUp (_, _.Library.String val)
	This class defines the set of common index transformation (or collation) methods. More...

_.Library.String	Collate (_.Library.String val, _.Library.String transSpec, _.Library.String length)
	Converts a logical value to COLLATE collation.

_.Library.String	Exact (_, _.Library.String val)
	Performs no transformation; the index value is exactly the logical value.

_.Library.Boolean	FMDEQDate (_.Library.FilemanDate fmd, _.Library.Date d)
	Compares a FilemanDate to a Date value with the = operator.

_.Library.Boolean	FMDEQPT (_.Library.FilemanDate fmd, _.Library.PosixTime pt)
	These methods deal with comparing Library.FilemanDate values with Library.PosixTime. More...

_.Library.Boolean	FMDEQTS (_.Library.FilemanDate fmd, _.Library.TimeStamp ts)
	These methods deal with comparing Library.FilemanDate values with Library.TimeStamp. More...

_.Library.Boolean	FMDGEDate (_.Library.FilemanDate fmd, _.Library.Date d)
	Compares a FilemanDate to a Date value with the '< operator.

_.Library.Boolean	FMDGEPT (_.Library.FilemanDate fmd, _.Library.PosixTime pt)
	Compares a FilemanDate to a PosixTime value with the '< operator.

_.Library.Boolean	FMDGETS (_.Library.FilemanDate fmd, _.Library.TimeStamp ts)
	Compares a FilemanDate to a TimeStamp value with the '< operator.

_.Library.Boolean	FMDGTDate (_.Library.FilemanDate fmd, _.Library.Date d)
	Compares a FilemanDate to a Date value with the > operator.

_.Library.Boolean	FMDGTPT (_.Library.FilemanDate fmd, _.Library.PosixTime pt)
	Compares a FilemanDate to a PosixTime value with the > operator.

_.Library.Boolean	FMDGTTS (_.Library.FilemanDate fmd, _.Library.TimeStamp ts)
	Compares a FilemanDate to a TimeStamp value with the > operator.

_.Library.Boolean	FMDLEDate (_.Library.FilemanDate fmd, _.Library.Date d)
	Compares a FilemanDate to a Date value with the '> operator.

_.Library.Boolean	FMDLEPT (_.Library.FilemanDate fmd, _.Library.PosixTime pt)
	Compares a FilemanDate to a PosixTime value with the '> operator.

_.Library.Boolean	FMDLETS (_.Library.FilemanDate fmd, _.Library.TimeStamp ts)
	Compares a FilemanDate to a TimeStamp value with the '> operator.

_.Library.Boolean	FMDLTDate (_.Library.FilemanDate fmd, _.Library.Date d)
	Compares a FilemanDate to a Date value with the < operator.

_.Library.Boolean	FMDLTPT (_.Library.FilemanDate fmd, _.Library.PosixTime pt)
	Compares a FilemanDate to a PosixTime value with the < operator.

_.Library.Boolean	FMDLTTS (_.Library.FilemanDate fmd, _.Library.TimeStamp ts)
	Compares a FilemanDate to a TimeStamp value with the < operator.

_.Library.Boolean	FMDNEDate (_.Library.FilemanDate fmd, _.Library.Date d)
	Compares a FilemanDate to a Date value with the '= operator.

_.Library.Boolean	FMDNEPT (_.Library.FilemanDate fmd, _.Library.PosixTime pt)
	Compares a FilemanDate to a PosixTime value with the '= operator.

_.Library.Boolean	FMDNETS (_.Library.FilemanDate fmd, _.Library.TimeStamp ts)
	Compares a FilemanDate to a TimeStamp value with the '= operator.

_.Library.Boolean	FMTSEQDate (_.Library.FilemanTimeStamp ts, _.Library.Date d)
	Compares a FilemanTimeStamp to a Date value with the = operator.

_.Library.Boolean	FMTSEQPT (_.Library.FilemanTimeStamp fmts, _.Library.PosixTime pt)
	Compares a FilemanTimeStamp to a PosixTime value with the = operator.

_.Library.Boolean	FMTSEQTS (_.Library.FilemanTimeStamp fmts, _.Library.TimeStamp ts)
	Compares a FilemanTimeStamp to a TimeStamp value with the = operator.

_.Library.Boolean	FMTSGEDate (_.Library.FilemanTimeStamp ts, _.Library.Date d)
	Compares a FilemanTimeStamp to a Date value with the '< operator.

_.Library.Boolean	FMTSGEPT (_.Library.FilemanTimeStamp fmts, _.Library.PosixTime pt)
	Compares a FilemanTimeStamp to a PosixTime value with the >= operator.

_.Library.Boolean	FMTSGETS (_.Library.FilemanTimeStamp fmts, _.Library.TimeStamp ts)
	Compares a FilemanTimeStamp to a TimeStamp value with the >= operator.

_.Library.Boolean	FMTSGTDate (_.Library.FilemanTimeStamp ts, _.Library.Date d)
	Compares a FilemanTimeStamp to a Date value with the > operator.

_.Library.Boolean	FMTSGTPT (_.Library.FilemanTimeStamp fmts, _.Library.PosixTime pt)
	Compares a FilemanTimeStamp to a PosixTime value with the > operator.

_.Library.Boolean	FMTSGTTS (_.Library.FilemanTimeStamp fmts, _.Library.TimeStamp ts)
	Compares a FilemanTimeStamp to a TimeStamp value with the > operator.

_.Library.Boolean	FMTSLEDate (_.Library.FilemanTimeStamp ts, _.Library.Date d)
	Compares a FilemanTimeStamp to a Date value with the '> operator.

_.Library.Boolean	FMTSLEPT (_.Library.FilemanTimeStamp fmts, _.Library.PosixTime pt)
	Compares a FilemanTimeStamp to a PosixTime value with the <= operator.

_.Library.Boolean	FMTSLETS (_.Library.FilemanTimeStamp fmts, _.Library.TimeStamp ts)
	Compares a FilemanTimeStamp to a TimeStamp value with the <= operator.

_.Library.Boolean	FMTSLTDate (_.Library.FilemanTimeStamp ts, _.Library.Date d)
	Compares a FilemanTimeStamp to a Date value with the < operator.

_.Library.Boolean	FMTSLTPT (_.Library.FilemanTimeStamp fmts, _.Library.PosixTime pt)
	Compares a FilemanTimeStamp to a PosixTime value with the < operator.

_.Library.Boolean	FMTSLTTS (_.Library.FilemanTimeStamp fmts, _.Library.TimeStamp ts)
	Compares a FilemanTimeStamp to a TimeStamp value with the < operator.

_.Library.Boolean	FMTSNEDate (_.Library.FilemanTimeStamp ts, _.Library.Date d)
	Compares a FilemanTimeStamp to a Date value with the '= operator.

_.Library.Boolean	FMTSNEPT (_.Library.FilemanTimeStamp fmts, _.Library.PosixTime pt)
	Compares a FilemanTimeStamp to a PosixTime value with the '= operator.

_.Library.Boolean	FMTSNETS (_.Library.FilemanTimeStamp fmts, _.Library.TimeStamp ts)
	Compares a FilemanTimeStamp to a TimeStamp value with the '= operator.

_.Library.Boolean	MVDEQDate (_.MV.Date mvd, _.Library.Date d)

_.Library.Boolean	MVDGEDate (_.MV.Date mvd, _.Library.Date d)
	Compares a MV.Date to a Date value with the '< operator.

_.Library.Boolean	MVDGTDate (_.MV.Date mvd, _.Library.Date d)
	Compares a MV.Date to a Date value with the > operator.

_.Library.Boolean	MVDLEDate (_.MV.Date mvd, _.Library.Date d)
	Compares a MV.Date to a Date value with the '> operator.

_.Library.Boolean	MVDLTDate (_.MV.Date mvd, _.Library.Date d)
	Compares a MV.Date to a Date value with the < operator.

_.Library.Boolean	MVDNEDate (_.MV.Date mvd, _.Library.Date d)
	Compares a MV.Date to a Date value with the '= operator.

_.Library.String	Minus (_, _.Library.String val)
	Prepends a minus ('-') sign to the logical value. More...

_.Library.String	Mvr (_, _.Library.String val)
	Converts a logical value to MVR collation.

_.Library.Boolean	PTEQDate (_.Library.PosixTime pt, _.Library.Date d)
	Compares a PosixTime to a Date value with the = operator.

_.Library.Boolean	PTEQTS (_.Library.PosixTime pt, _.Library.TimeStamp ts)
	Compares a PosixTime to a TimeStamp value with the = operator.

_.Library.Boolean	PTGEDate (_.Library.TimeStamp pt, _.Library.Date d)
	Compares a PosixTime to a Date value with the '< operator.

_.Library.Boolean	PTGETS (_.Library.PosixTime pt, _.Library.TimeStamp ts)
	Compares a PosixTime to a TimeStamp value with the '< operator.

_.Library.Boolean	PTGTDate (_.Library.TimeStamp pt, _.Library.Date d)
	Compares a PosixTime to a Date value with the > operator.

_.Library.Boolean	PTGTTS (_.Library.PosixTime pt, _.Library.TimeStamp ts)
	Compares a PosixTime to a TimeStamp value with the > operator.

_.Library.Boolean	PTLEDate (_.Library.TimeStamp pt, _.Library.Date d)
	Compares a PosixTime to a Date value with the '> operator.

_.Library.Boolean	PTLETS (_.Library.PosixTime pt, _.Library.TimeStamp ts)
	Compares a PosixTime to a TimeStamp value with the '> operator.

_.Library.Boolean	PTLTDate (_.Library.TimeStamp pt, _.Library.Date d)
	Compares a PosixTime to a Date value with the < operator.

_.Library.Boolean	PTLTTS (_.Library.PosixTime pt, _.Library.TimeStamp ts)
	Compares a PosixTime to a TimeStamp value with the < operator.

_.Library.Boolean	PTNEDate (_.Library.TimeStamp pt, _.Library.Date d)
	Compares a PosixTime to a Date value with the '= operator.

_.Library.Boolean	PTNETS (_.Library.PosixTime pt, _.Library.TimeStamp ts)
	Compares a PosixTime to a TimeStamp value with the '= operator.

_.Library.String	Plus (_, _.Library.String val)
	Prepends a plus ('+') sign to the logical value. More...

_.Library.String	Space (_, _.Library.String val)
	Prepends a space (' ') character to the logical value. More...

_.Library.String	SqlString (_, _.Library.String val, _.Library.Integer maxlen)
	Prepends a space to force string collation and strips trailing whitespace. More...

_.Library.String	SqlUpper (_, _.Library.String val, _.Library.Integer maxlen)
	Converts a logical value to upper case, strips trailing whitespace and prepends a space. More...

_.Library.String	String (_, _.Library.String val, _.Library.Integer maxlen)
	Converts a logical value to upper case, strips all punctuation and white space. More...

_.Library.Boolean	TSEQDate (_.Library.TimeStamp ts, _.Library.Date d)
	Compares a TimeStamp to a Date value with the = operator.

_.Library.Boolean	TSEQMVDate (_.Library.TimeStamp ts, _.MV.Date d)

_.Library.Boolean	TSGEDate (_.Library.TimeStamp ts, _.Library.Date d)
	Compares a TimeStamp to a Date value with the '< operator.

_.Library.Boolean	TSGEMVDate (_.Library.TimeStamp ts, _.MV.Date d)
	Compares a TimeStamp to a MV.Date value with the '< operator.

_.Library.Boolean	TSGTDate (_.Library.TimeStamp ts, _.Library.Date d)
	Compares a TimeStamp to a Date value with the > operator.

_.Library.Boolean	TSGTMVDate (_.Library.TimeStamp ts, _.MV.Date d)
	Compares a TimeStamp to a MV.Date value with the > operator.

_.Library.Boolean	TSLEDate (_.Library.TimeStamp ts, _.Library.Date d)
	Compares a TimeStamp to a Date value with the '> operator.

_.Library.Boolean	TSLEMVDate (_.Library.TimeStamp ts, _.MV.Date d)
	Compares a TimeStamp to a MV.Date value with the '> operator.

_.Library.Boolean	TSLTDate (_.Library.TimeStamp ts, _.Library.Date d)
	Compares a TimeStamp to a Date value with the < operator.

_.Library.Boolean	TSLTMVDate (_.Library.TimeStamp ts, _.MV.Date d)
	Compares a TimeStamp to a MV.Date value with the < operator.

_.Library.Boolean	TSNEDate (_.Library.TimeStamp ts, _.Library.Date d)
	Compares a TimeStamp to a Date value with the '= operator.

_.Library.Boolean	TSNEMVDate (_.Library.TimeStamp ts, _.MV.Date d)
	Compares a TimeStamp to a MV.Date value with the '= operator.

_.Library.String	Truncate (_, _.Library.String val, _.Library.Integer len)
	Converts a logical value to exact colation with a defined length limit.

_.Library.String	Upper (_, _.Library.String val)
	Converts a logical value to upper case without removing any characters.

Detailed Description

This class defines the set of common index transformation (or collation) methods.

An index transformation is used to tranform logical data values into values used by indices.

For example, you may wish that a query by name finds the same results for both "ELVIS" and "elvis". Using a case-insensitive index transformation, such as String, will accomplish this. If you want an exact match, use Exact.

Index transformations are specified via a property's COLLATION parameter. Every datatype has a default COLLATION value, which matches one of the methods of the Collation class. The COLLATION parameter can be overwritten by an individual property or by a specific index definition.

Note that changing a property's COLLATION value will corrupt any index values currently stored for that property and will require you to manually repopulate the index.

Member Function Documentation

◆ AlphaUp()

_.Library.String AlphaUp	(		_,
		_.Library.String	val
	)

static

This class defines the set of common index transformation (or collation) methods.

An index transformation is used to tranform logical data values into values used by indices.

For example, you may wish that a query by name finds the same results for both "ELVIS" and "elvis". Using a case-insensitive index transformation, such as String, will accomplish this. If you want an exact match, use Exact.

Index transformations are specified via a property's COLLATION parameter. Every datatype has a default COLLATION value, which matches one of the methods of the Collation class. The COLLATION parameter can be overwritten by an individual property or by a specific index definition.

Note that changing a property's COLLATION value will corrupt any index values currently stored for that property and will require you to manually repopulate the index.

Converts a logical value to upper case, strips all punctuation and white space

(except for ',' and '?').

This method is included for compatability with earlier products; use String instead.

◆ FMDEQPT()

_.Library.Boolean FMDEQPT	(	_.Library.FilemanDate	fmd,
		_.Library.PosixTime	pt
	)

static

These methods deal with comparing Library.FilemanDate values with Library.PosixTime.

Compares a FilemanDate to a PosixTime value with the = operator.

◆ FMDEQTS()

_.Library.Boolean FMDEQTS	(	_.Library.FilemanDate	fmd,
		_.Library.TimeStamp	ts
	)

static

These methods deal with comparing Library.FilemanDate values with Library.TimeStamp.

Compares a FilemanDate to a TimeStamp value with the = operator.

◆ MVDEQDate()

_.Library.Boolean MVDEQDate	(	_.MV.Date	mvd,
		_.Library.Date	d
	)

static

These methods deal with comparing MV.Date values with Library.Date The MultiValue start date is 01/01/1968
ObjectScript date is 01/01/1841

To convert an ObjectScript date ($h) to a MultiValue date:
MVdate = ObjectScript date - 46385

To convert a MultiValue date to an ObjectScript date:

ObjectScript date = MVdate + 46385

Compares a MV.Date to a Date value with the = operator.

◆ Minus()

_.Library.String Minus	(		_,
		_.Library.String	val
	)

static

Prepends a minus ('-') sign to the logical value.

This method is included for compatability with earlier products; you should not need it in new applications.

◆ Plus()

_.Library.String Plus	(		_,
		_.Library.String	val
	)

static

Prepends a plus ('+') sign to the logical value.

This method is included for compatability with earlier products; you should not need it in new applications.

◆ Space()

_.Library.String Space	(		_,
		_.Library.String	val
	)

static

Prepends a space (' ') character to the logical value.

This method is included for compatability with earlier products; you should not need it in new applications.

◆ SqlString()

_.Library.String SqlString	(		_,
		_.Library.String	val,
		_.Library.Integer	maxlen
	)

static

Prepends a space to force string collation and strips trailing whitespace.

This method is used to insure that strings are collated case-sensitively and that numeric string values are collated correctly.

◆ SqlUpper()

_.Library.String SqlUpper	(		_,
		_.Library.String	val,
		_.Library.Integer	maxlen
	)

static

Converts a logical value to upper case, strips trailing whitespace and prepends a space.

to force string collation.

This method is used to insure that strings are collated case-insensitively and that numeric string values are collated correctly.

◆ String()

_.Library.String String	(		_,
		_.Library.String	val,
		_.Library.Integer	maxlen
	)

static

Converts a logical value to upper case, strips all punctuation and white space.

(except for ',').

This method is used to insure that strings are collated case-insensitively and that numeric string values are collated correctly.

◆ TSEQMVDate()

_.Library.Boolean TSEQMVDate	(	_.Library.TimeStamp	ts,
		_.MV.Date	d
	)

static

These methods deal with comparing %MV.Date values with %Library.TimeStamp

Compares a TimeStamp to a MV.Date value with the = operator.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AlphaUp()

◆ FMDEQPT()

◆ FMDEQTS()

◆ MVDEQDate()

ObjectScript date = MVdate + 46385 <br>

◆ Minus()

◆ Plus()

◆ Space()

◆ SqlString()

◆ SqlUpper()

◆ String()

◆ TSEQMVDate()

These methods deal with comparing %MV.Date values with %Library.TimeStamp