com.pervasive.datarush.tokens.record

Class SortedJoinKey

java.lang.Object

com.pervasive.datarush.tokens.record.SortedJoinKey

public final class SortedJoinKey
extends Object

Combination of a left key, a right key, and an ordering.

Constructor Summary

Constructors

Constructor and Description
SortedJoinKey(JoinKey key, TokenOrder ordering) Create a key using the specified order.
SortedJoinKey(String name) Create a key using ascending order, where the left name and right name are the same.
SortedJoinKey(String name, TokenOrder ordering) Create a key using the specified order, where the left name and right name are the same.

Method Summary

Modifier and Type	Method and Description
static SortedJoinKey[]	asc(JoinKey... keys) Create multiple ascending keys.
static SortedJoinKey[]	asc(String... names) Create multiple ascending keys.
static SortedJoinKey	asc(String name) Create an ascending key.
static SortedJoinKey[]	desc(JoinKey... names) Create multiple descending keys.
static SortedJoinKey[]	desc(String... names) Create multiple descending keys.
static SortedJoinKey	desc(String name) Create a descending key.
JoinKey	getKey() Get the left field name associated with this key.
static JoinKey[]	getKeys(SortedJoinKey... joinKeys) Extract the join keys from several keys.
static SortKey[]	getLeftKeys(SortedJoinKey... joinKeys) Extract the left sort keys from several sorted join keys
TokenOrder	getOrder() Get the ordering associated with this key.
static TokenOrder[]	getOrders(SortedJoinKey... joinKeys) Extract the orderings from several keys.
static SortKey[]	getRightKeys(SortedJoinKey... joinKeys) Extract the right sort keys from several sorted join keys
static SortedJoinKey[]	makeJoinKeys(TokenOrder[] order, JoinKey[] names) Create multiple keys using the specified order.
static SortedJoinKey[]	makeJoinKeys(TokenOrder order, JoinKey... names) Create multiple keys using the specified order.
String	toString() Pretty-print this JoinKey.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SortedJoinKey

public SortedJoinKey(String name)

Create a key using ascending order, where the left name and right name are the same.

Parameters:

name - Name of the key field on both the left and right

SortedJoinKey

public SortedJoinKey(String name,
                     TokenOrder ordering)

Create a key using the specified order, where the left name and right name are the same.

Parameters:

name - Name of the key on both the left and right

ordering - Order of the data

SortedJoinKey

public SortedJoinKey(JoinKey key,
                     TokenOrder ordering)

Create a key using the specified order.

Parameters:

key - the key containing the left and right name

ordering - Order of the data

Method Detail

getKey

public JoinKey getKey()

Get the left field name associated with this key.

Returns:

Name of the key field

getOrder

public TokenOrder getOrder()

Get the ordering associated with this key.

Returns:

Key's ordering

toString

public String toString()

Pretty-print this JoinKey.

Overrides:

toString in class Object

Returns:

String containing field name and associated ordering

asc

public static SortedJoinKey asc(String name)

Create an ascending key.

Parameters:

name - Name of the key field

Returns:

ascending join key

asc

public static SortedJoinKey[] asc(String... names)

Create multiple ascending keys.

Parameters:

names - Names of the key fields on both left and right

Returns:

Ascending join keys, in the same order as the supplied field names

asc

public static SortedJoinKey[] asc(JoinKey... keys)

Create multiple ascending keys.

Parameters:

keys - Join keys

Returns:

Ascending join keys, in the same order as the supplied field names

desc

public static SortedJoinKey desc(String name)

Create a descending key.

Parameters:

name - Name of the key field

Returns:

Descending join key

desc

public static SortedJoinKey[] desc(String... names)

Create multiple descending keys.

Parameters:

names - Names of the key fields on both left and right

Returns:

Descending join keys, in the same order as the supplied field names

desc

public static SortedJoinKey[] desc(JoinKey... names)

Create multiple descending keys.

Parameters:

names - Names of the key fields

Returns:

Descending join keys, in the same order as the supplied field names

makeJoinKeys

public static SortedJoinKey[] makeJoinKeys(TokenOrder order,
                                           JoinKey... names)

Create multiple keys using the specified order.

Parameters:

order - Ordering to use for the keys

names - Names of the key fields

Returns:

Join keys, in the same order as the supplied field names

makeJoinKeys

public static SortedJoinKey[] makeJoinKeys(TokenOrder[] order,
                                           JoinKey[] names)

Create multiple keys using the specified order.

Parameters:

order - Ordering to use for the keys

names - Names of the key fields

Returns:

Join keys, in the same order as the supplied field names

getKeys

public static JoinKey[] getKeys(SortedJoinKey... joinKeys)

Extract the join keys from several keys.

Parameters:

joinKeys - Keys from which to get the field names

Returns:

Field names for the keys, in the same order as the supplied keys

getLeftKeys

public static SortKey[] getLeftKeys(SortedJoinKey... joinKeys)

Extract the left sort keys from several sorted join keys

Parameters:

joinKeys - the join keys specifying a sort order

Returns:

the sort keys for the left side of the join

getRightKeys

public static SortKey[] getRightKeys(SortedJoinKey... joinKeys)

Extract the right sort keys from several sorted join keys

Parameters:

joinKeys - the join keys specifying a sort order

Returns:

the sort keys for the right side of the join

getOrders

public static TokenOrder[] getOrders(SortedJoinKey... joinKeys)

Extract the orderings from several keys.

Parameters:

joinKeys - Keys from which to get the orderings

Returns:

Orderings for the keys, in the same order as the supplied keys