Slice (d4core 4.5.0 API)

java.lang.Object
- dap4.core.util.Slice

```
public class Slice
extends Object
```
A Slice is used for two purposes
1. To specify a subset of data to extract.
2. To specify a subset of data as specified in a constraint.
In case two, the "last" value of the slice may be undefined (e.q. specifying [0:*]) and so they must be filled in at some point. Note that first cannot be undefined because it always defaults to zero; similarly stride defaults to one.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`constrained` Indicate that this slice's first/last/stride were specifically set; typically from a constraint.
`static long`	`MAXLENGTH`
`static long`	`UNDEFINED`

Constructor Summary

Constructors
Constructor and Description

Slice()

Slice(long first, long last, long stride)

Slice(Slice s)

Constructors
Constructor and Description
`Slice()`
`Slice(long first, long last, long stride)`
`Slice(Slice s)`

Method Summary

Methods
Modifier and Type	Method and Description
`Slice`	`complete(DapDimension dim)`
`static Slice`	`compose(Slice target, Slice src)` Take two slices and compose src wrt target Assume neither argument is null.
`boolean`	`equals(Object o)` Compare two slices for equality
`Slice`	`fill(DapDimension dim)`
`long`	`getCount()` Compute the number of elements int the slice.
`long`	`getFirst()`
`long`	`getLast()`
`long`	`getStride()`
`boolean`	`incomplete()`
`Boolean`	`isConstrained()`
`Boolean`	`isWhole()`
`Slice`	`setConstrained(Boolean tf)`
`Slice`	`setIndices(long first, long last, long stride)`
`Slice`	`setWhole(Boolean tf)`
`Slice`	`setWholeWRT(long maxsize)`
`String`	`toConstraintString()` Convert this slice to a bracketed string suitable for use in a constraint
`String`	`toString()`
`Slice`	`validate()` Perform sanity checks on a slice

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNDEFINED
```
public static final long UNDEFINED
```
    See Also:
    Constant Field Values
  - MAXLENGTH
```
public static final long MAXLENGTH
```
    See Also:
    Constant Field Values
  - constrained
```
protected boolean constrained
```
    Indicate that this slice's first/last/stride were specifically set; typically from a constraint. Defaults to true.
- Constructor Detail
  - Slice
```
public Slice()
```
  - Slice
```
public Slice(long first,
     long last,
     long stride)
      throws DapException
```
    Throws:
    
    DapException
  - Slice
```
public Slice(Slice s)
      throws DapException
```
    Throws:
    
    DapException
- Method Detail
  - getFirst
```
public long getFirst()
```
  - getLast
```
public long getLast()
```
  - getStride
```
public long getStride()
```
  - complete
```
public Slice complete(DapDimension dim)
```
  - fill
```
public Slice fill(DapDimension dim)
           throws DapException
```
    Throws:
    
    DapException
  - setIndices
```
public Slice setIndices(long first,
               long last,
               long stride)
                 throws DapException
```
    Throws:
    
    DapException
  - isWhole
```
public Boolean isWhole()
```
  - setWhole
```
public Slice setWhole(Boolean tf)
```
  - setWholeWRT
```
public Slice setWholeWRT(long maxsize)
```
  - isConstrained
```
public Boolean isConstrained()
```
  - setConstrained
```
public Slice setConstrained(Boolean tf)
```
  - incomplete
```
public boolean incomplete()
```
  - getCount
```
public long getCount()
```
    Compute the number of elements int the slice. Note that this is different from the getLast()+1
  - equals
```
public boolean equals(Object o)
```
    Compare two slices for equality
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - the other slice to compare with
    
    Returns:
    true if this and other are the same, false otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toConstraintString
```
public String toConstraintString()
```
    Convert this slice to a bracketed string suitable for use in a constraint
    
    Returns:
    constraint usable string
  - compose
```
public static Slice compose(Slice target,
            Slice src)
                     throws DapException
```
    Take two slices and compose src wrt target Assume neither argument is null. This code should match ucar.ma2.Section in thredds and dceconstraint.c in the netcdf-c library.
    
    Parameters:
    target -
    src -
    
    Returns:
    new, composed Range
    
    Throws:
    
    DapException
  - validate
```
public Slice validate()
               throws DapException
```
    Perform sanity checks on a slice
    
    Throws:
    
    DapException - if slice is malformed

Class Slice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNDEFINED

MAXLENGTH

constrained

Constructor Detail

Slice

Slice

Slice

Method Detail

getFirst

getLast

getStride

complete

fill

setIndices

isWhole

setWhole

setWholeWRT

isConstrained

setConstrained

incomplete

getCount

equals

toString

toConstraintString

compose

validate