Module swim.structure

Package swim.structure.selector

Class IdentitySelector

java.lang.Object

swim.structure.Item

swim.structure.Value

swim.structure.Expression

swim.structure.Selector

swim.structure.selector.IdentitySelector

All Implemented Interfaces:

Comparable<Item>, Iterable<Item>, swim.codec.Debug, swim.codec.Display

public final class IdentitySelector
extends Selector

Method Summary

Modifier and Type	Method	Description
Selector	andThen(Selector then)	The means to chain Selectors.
Selector	children()	An abstraction over Selector.andThen(swim.structure.Selector) where then is the ChildrenSelector.
protected int	compareTo(Selector that)
<T> swim.codec.Output<T>	debugThen(swim.codec.Output<T> output)
Selector	descendants()	An abstraction over Selector.andThen(swim.structure.Selector) where then is the DescendantsSelector.
boolean	equals(Object other)
<T> T	forSelected(Interpreter interpreter, Selectee<T> callback)	Evaluates callback.selected against the Items that match this Selector's selection criteria.
Selector	get(Value key)	An abstraction over Selector.andThen(swim.structure.Selector) where then is a GetSelector.
Selector	getAttr(Text key)	An abstraction over Selector.andThen(swim.structure.Selector) where then is a GetAttrSelector.
Selector	getItem(Num index)	An abstraction over Selector.andThen(swim.structure.Selector) where then is a GetItemSelector.
int	hashCode()
static IdentitySelector	identity()
Selector	keys()	An abstraction over Selector.andThen(swim.structure.Selector) where then is the KeysSelector.
Item	mapSelected(Interpreter interpreter, Selectee<Item> transform)
Item	substitute(Interpreter interpreter)
Selector	then()	Returns the Selector that this Selector uses to match sub-selections.
int	typeOrder()	Returns the heterogeneous sort order of this Item.
Selector	values()	An abstraction over Selector.andThen(swim.structure.Selector) where then is the ValuesSelector.

Methods inherited from class swim.structure.Selector

compareTo, debug, evaluate, filter, filter, get, getAttr, getItem, invoke, isConstant, literal, precedence

Methods inherited from class swim.structure.Expression

and, and, bitwiseAnd, bitwiseAnd, bitwiseNot, bitwiseOr, bitwiseOr, bitwiseXor, bitwiseXor, conditional, conditional, divide, divide, eq, eq, ge, ge, gt, gt, inverse, le, le, lt, lt, minus, minus, modulo, modulo, ne, ne, negative, not, or, or, plus, plus, positive, times, times

Methods inherited from class swim.structure.Value

absent, alias, body, booleanValue, booleanValue, branch, builder, byteValue, byteValue, charValue, charValue, commit, contains, containsKey, containsKey, containsValue, doubleValue, doubleValue, empty, extant, flattened, floatValue, floatValue, fromObject, getField, getField, getSlot, getSlot, head, header, headers, integerValue, integerValue, intValue, intValue, isAliased, isDefined, isDefinite, isDistinct, isMutable, key, keyEquals, lambda, length, longValue, longValue, numberValue, numberValue, removed, removed, shortValue, shortValue, stringValue, stringValue, tag, tail, target, toValue, unflattened

Methods inherited from class swim.structure.Item

appended, appended, appended, appended, appended, appended, appended, appended, cast, cast, coerce, coerce, concat, display, evaluate, globalScope, iterator, max, min, prepended, prepended, prepended, prepended, prepended, prepended, prepended, prepended, substitute, toString, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updated, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedAttr, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot, updatedSlot

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

then

public Selector then()

Description copied from class: Selector

Returns the Selector that this Selector uses to match sub-selections.

Specified by:

then in class Selector

forSelected

public <T> T forSelected(Interpreter interpreter,
 Selectee<T> callback)

Description copied from class: Selector

Evaluates callback.selected against the Items that match this Selector's selection criteria. That is, it pushes such Items to interpreter, then invokes callback against it. To support chained Selectors, this is a recursive procedure that invokes forSelected through this.then wherever it exists (which it always does outside of IdentitySelector); we define "subselection" to be such an invocation.

Specified by:

forSelected in class Selector

Returns:

the result of executing callback from the context of the last Selector in the chain formed by Selector then fields.

mapSelected

public Item mapSelected(Interpreter interpreter,
 Selectee<Item> transform)

Specified by:

mapSelected in class Selector

substitute

public Item substitute(Interpreter interpreter)

Overrides:

substitute in class Item

get

public Selector get(Value key)

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is a GetSelector.

Overrides:

get in class Selector

Parameters:

key - the key field in the composing GetSelector.

getAttr

public Selector getAttr(Text key)

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is a GetAttrSelector.

Overrides:

getAttr in class Selector

Parameters:

key - the key field in the composing GetAttrSelector.

getItem

public Selector getItem(Num index)

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is a GetItemSelector.

Overrides:

getItem in class Selector

Parameters:

index - the index field in the composing GetItemSelector.

andThen

public Selector andThen(Selector then)

Description copied from class: Selector

The means to chain Selectors. By intention, this is NOT a strict functional composition: for two Selectors s1 and s2, s1.andThen(s2) DOES NOT NECESSARILY return a new Selector s3 such that s3.evaluate(args) is equivalent to s2.evaluate(s1.evaluate(args)).

The reason for this is that for Selectors like ChildrenSelector that yield (logical) collections, we wish to invoke the next Selector, say a GetSelector, against every result. Under strict functional rules, ChildrenSelector.andThen(someGetSelector).evaluate(args) would instead return at most one defined value regardless of the number of children.

Specified by:

andThen in class Selector

keys

public Selector keys()

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is the KeysSelector.

Overrides:

keys in class Selector

values

public Selector values()

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is the ValuesSelector.

Overrides:

values in class Selector

children

public Selector children()

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is the ChildrenSelector.

Overrides:

children in class Selector

descendants

public Selector descendants()

Description copied from class: Selector

An abstraction over Selector.andThen(swim.structure.Selector) where then is the DescendantsSelector.

Overrides:

descendants in class Selector

typeOrder

public int typeOrder()

Description copied from class: Item

Returns the heterogeneous sort order of this Item. Used to impose a total order on the set of all items. When comparing two items of different types, the items order according to their typeOrder.

Specified by:

typeOrder in class Item

compareTo

protected int compareTo(Selector that)

Specified by:

compareTo in class Selector

equals

public boolean equals(Object other)

Specified by:

equals in class Item

hashCode

public int hashCode()

Specified by:

hashCode in class Item

debugThen

public <T> swim.codec.Output<T> debugThen(swim.codec.Output<T> output)

Specified by:

debugThen in class Selector

identity

public static IdentitySelector identity()