dap4.core.util

Class Slice

java.lang.Object

dap4.core.util.Slice

Direct Known Subclasses:

MultiSlice

public class Slice
extends java.lang.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. Slice Supports iteration. Note that a slice is quite similar to a scalar DataIndex. Modifiied 10/15/2016 to support zero sized slices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Slice.Sort

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 int	MAXLENGTH
static Slice	SCALARSLICE
static java.util.List<Slice>	SCALARSLICES
protected Slice.Sort	sort
static int	UNDEFINED

Constructor Summary

Constructors

Constructor and Description
Slice()
Slice(DapDimension dim)
Slice(int first, int stop, int stride)
Slice(int first, int stop, int stride, int maxsize)
Slice(Slice s)

Method Summary

Modifier and Type	Method and Description
static Slice	compose(Slice target, Slice src) Take two slices and compose src wrt target Assume neither argument is null.
boolean	equals(java.lang.Object o) Compare two slices for equality
Slice	finish() Perform sanity checks on a slice and repair where possible.
int	getCount() Compute the number of elements in the slice.
int	getFirst()
int	getLast()
int	getMax()
int	getSize()
Slice.Sort	getSort()
int	getStop()
int	getStride()
Slice	getSubSlice(int i)
java.util.List<Slice>	getSubSlices()
int	hashCode()
java.lang.Boolean	isConstrained()
boolean	isScalar()
java.lang.Boolean	isWhole()
SliceIterator	iterator()
Slice	setConstrained(java.lang.Boolean tf)
Slice	setIndices(int first, int stop, int stride)
Slice	setIndices(int first, int stop, int stride, int maxsize)
Slice	setMaxSize(int size)
Slice	setWhole(java.lang.Boolean tf)
java.lang.String	toConstraintString() Convert this slice to a string suitable for use in a constraint
java.lang.String	toString()
java.lang.String	toString(boolean withbrackets)

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

MAXLENGTH

public static final int MAXLENGTH

See Also:

Constant Field Values

SCALARSLICES

public static java.util.List<Slice> SCALARSLICES

SCALARSLICE

public static Slice SCALARSLICE

sort

protected Slice.Sort sort

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(int first,
             int stop,
             int stride)
      throws DapException

Throws:

DapException

Slice

public Slice(int first,
             int stop,
             int stride,
             int maxsize)
      throws DapException

Throws:

DapException

Slice

public Slice(Slice s)
      throws DapException

Throws:

DapException

Slice

public Slice(DapDimension dim)
      throws DapException

Throws:

DapException

Method Detail

finish

public Slice finish()
             throws DapException

Perform sanity checks on a slice and repair where possible.

Returns:

this (fluent interface)

Throws:

DapException - if slice is malformed

iterator

public SliceIterator iterator()

getSort

public Slice.Sort getSort()

getFirst

public int getFirst()

getStop

public int getStop()

getLast

public int getLast()

getStride

public int getStride()

getSize

public int getSize()

getMax

public int getMax()

isScalar

public boolean isScalar()

setMaxSize

public Slice setMaxSize(int size)
                 throws DapException

Throws:

DapException

setIndices

public Slice setIndices(int first,
                        int stop,
                        int stride)
                 throws DapException

Throws:

DapException

setIndices

public Slice setIndices(int first,
                        int stop,
                        int stride,
                        int maxsize)
                 throws DapException

Throws:

DapException

isWhole

public java.lang.Boolean isWhole()

setWhole

public Slice setWhole(java.lang.Boolean tf)

isConstrained

public java.lang.Boolean isConstrained()

setConstrained

public Slice setConstrained(java.lang.Boolean tf)

getCount

public int getCount()

Compute the number of elements in the slice. Note that this is different from getStop() because stride is taken into account.

equals

public boolean equals(java.lang.Object o)

Compare two slices for equality

Overrides:

equals in class java.lang.Object

Parameters:

o - the other slice to compare with

Returns:

true if this and other are the same, false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean withbrackets)

toConstraintString

public java.lang.String toConstraintString()
                                    throws DapException

Convert this slice to a string suitable for use in a constraint

Returns:

constraint usable string

Throws:

DapException

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

getSubSlices

public java.util.List<Slice> getSubSlices()

getSubSlice

public Slice getSubSlice(int i)