CalculateCommand.State (Concourse Java API)

Object
- CalculateCommand.State

All Implemented Interfaces:

Command

Enclosing class:

CalculateCommand
```
public static final class CalculateCommand.State
extends Object
```
The terminal state for a calculate command. Supports optional in, where, and at clauses that can be chained fluently.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CalculateCommand.State`	`at(Timestamp timestamp)` Pin this calculation to a historical `Timestamp`.
`String`	`ccl()` Return a CCL string equivalent to this `Command`.
`String`	`condition()` Return the raw CCL condition for this command.
`Criteria`	`criteria()` Return the `Criteria` for this command.
`boolean`	`equals(Object obj)`
`CalculateCommand.State`	`from(long record)` Alias for `in(long)` to support alternate CCL dialects.
`CalculateCommand.State`	`from(long record, long... moreRecords)` Alias for `in(long, long...)` to support alternate CCL dialects.
`String`	`function()` Return the aggregation function for this command.
`int`	`hashCode()`
`CalculateCommand.State`	`in(long record)` Scope this calculation to the specified `record`.
`CalculateCommand.State`	`in(long record, long... moreRecords)` Scope this calculation to the specified records.
`String`	`key()` Return the key for this command.
`List<Long>`	`records()` Return the target records for this command.
`Timestamp`	`timestamp()` Return the historical `Timestamp` for this command.
`String`	`toString()`
`CalculateCommand.State`	`where(Criteria criteria)` Scope this calculation to records matching the `Criteria`.
`CalculateCommand.State`	`where(String ccl)` Scope this calculation to records matching the CCL condition string.
`CalculateCommand.State`	`within(long record)` Alias for `in(long)` to support alternate CCL dialects.
`CalculateCommand.State`	`within(long record, long... moreRecords)` Alias for `in(long, long...)` to support alternate CCL dialects.

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Command
go, is, parse, parseAll, to

- Method Detail
  - in
```
public CalculateCommand.State in(long record)
```
    Scope this calculation to the specified record.
    
    Parameters:
    
    record - the target record
    
    Returns:
    
    this state for further chaining
  - in
```
public CalculateCommand.State in(long record,
                                 long... moreRecords)
```
    Scope this calculation to the specified records.
    
    Parameters:
    
    record - the first record
    
    moreRecords - additional records
    
    Returns:
    
    this state for further chaining
  - from
```
public CalculateCommand.State from(long record)
```
    Alias for in(long) to support alternate CCL dialects.
    
    Parameters:
    
    record - the target record
    
    Returns:
    
    this state for further chaining
  - from
```
public CalculateCommand.State from(long record,
                                   long... moreRecords)
```
    Alias for in(long, long...) to support alternate CCL dialects.
    
    Parameters:
    
    record - the first record
    
    moreRecords - additional records
    
    Returns:
    
    this state for further chaining
  - within
```
public CalculateCommand.State within(long record)
```
    Alias for in(long) to support alternate CCL dialects.
    
    Parameters:
    
    record - the target record
    
    Returns:
    
    this state for further chaining
  - within
```
public CalculateCommand.State within(long record,
                                     long... moreRecords)
```
    Alias for in(long, long...) to support alternate CCL dialects.
    
    Parameters:
    
    record - the first record
    
    moreRecords - additional records
    
    Returns:
    
    this state for further chaining
  - where
```
public CalculateCommand.State where(Criteria criteria)
```
    Scope this calculation to records matching the Criteria.
    
    Parameters:
    
    criteria - the Criteria
    
    Returns:
    
    this state for further chaining
  - where
```
public CalculateCommand.State where(String ccl)
```
    Scope this calculation to records matching the CCL condition string.
    
    Parameters:
    
    ccl - the CCL condition
    
    Returns:
    
    this state for further chaining
  - at
```
public CalculateCommand.State at(Timestamp timestamp)
```
    Pin this calculation to a historical Timestamp.
    
    Parameters:
    
    timestamp - the Timestamp
    
    Returns:
    
    this state for further chaining
  - function
```
public String function()
```
    Return the aggregation function for this command.
    
    Returns:
    
    the function name
  - key
```
public String key()
```
    Return the key for this command.
    
    Returns:
    
    the key
  - records
```
@Nullable
public List<Long> records()
```
    Return the target records for this command.
    
    Returns:
    
    the records, or null
  - criteria
```
@Nullable
public Criteria criteria()
```
    Return the Criteria for this command.
    
    Returns:
    
    the Criteria, or null
  - condition
```
@Nullable
public String condition()
```
    Return the raw CCL condition for this command.
    
    Returns:
    
    the condition string, or null
  - timestamp
```
@Nullable
public Timestamp timestamp()
```
    Return the historical Timestamp for this command.
    
    Returns:
    
    the Timestamp, or null
  - ccl
```
public String ccl()
```
    Description copied from interface: Command
    
    Return a CCL string equivalent to this Command.
    
    Returns:
    
    the CCL string
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CalculateCommand.State

Method Summary

Methods inherited from class Object

Methods inherited from interface Command

Method Detail

in

in

from

from

within

within

where

where

at

function

key

records

criteria

condition

timestamp

ccl

equals

hashCode

toString