dap4.core.util

Class DapUtil

java.lang.Object

dap4.core.util.DapUtil

public abstract class DapUtil
extends java.lang.Object

Misc. Utility methods

Field Summary

Fields

Modifier and Type	Field and Description
static java.math.BigInteger	BIG_UMASK64
static java.lang.String	CRLF
static int	CRLFSIZE
static java.util.regex.Pattern	DAP4EXT_RE
static java.lang.String	LF
static java.nio.ByteOrder	NATIVE_ORDER
static java.nio.ByteOrder	NETWORK_ORDER
static java.nio.charset.Charset	UTF8

Constructor Summary

Constructors

Constructor and Description
DapUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	absolutize(java.lang.String path)
static java.util.List<java.lang.String>	backslashSplit(java.lang.String s, char sep) Split a string with respect to a separator character and taking backslashes into consideration.
static java.lang.String	canonFileURL(java.lang.String url)
static java.lang.String	canonicalpath(java.lang.String path) Convert path to: 1.
static java.lang.String	canonjoin(java.lang.String prefix, java.lang.String suffix)
static boolean	checkFixedSize(DapVariable var)
static void	checkruntime(java.lang.Exception e) Re-throw run-time exceptions
static java.lang.String	denullify(java.lang.String path) Convert null paths to ""
static long	dimProduct(java.util.List<DapDimension> dimset)
static java.util.List<Slice>	dimsetToSlices(java.util.List<DapDimension> dimset)
static byte[]	extract(java.nio.ByteBuffer buf) Properly extract the byte contents of a ByteBuffer
static java.lang.String	fqnPrefix(java.lang.String fqn)
static java.lang.String	fqnSuffix(java.lang.String fqn)
static long[]	getDimSizes(java.util.List<DapDimension> dims)
static java.util.List<java.lang.String>	getProtocols(java.lang.String url, int[] breakpoint) Return the set of leading protocols for a url; may be more than one.
static java.util.List<DapVariable>	getStructurePath(DapVariable var) Given a dap variable, get the path from the top-level variable to and including the given variable such that all but the last element is a structure.
static boolean	hasDriveLetter(java.lang.String path) Return true if this path appears to start with a windows drive letter This tests the patterns "/x:/" and "x:/"
static boolean	hasSequence(DapNode node)
static boolean	hasStrideOne(java.util.List<Slice> slices)
static boolean	hasWindowsDrive(java.lang.String path)
static int[]	intvector(long[] lv)
static boolean	isAbsolutePath(java.lang.String path)
static boolean	isContiguous(java.util.List<Slice> slices) Test if a set of slices represent a contiguous region This is equivalent to saying all strides are one
static boolean	isScalarSlices(java.util.List<Slice> slices)
static boolean	isSinglePoint(java.util.List<Slice> slices) Test if a set of slices represent a single position
static boolean	isWhole(java.util.List<Slice> slices, java.util.List<DapDimension> dimset) Test a List against set of DapDimensions to see if the list is whole wrt the dimensions
static java.lang.String	join(java.lang.String[] array, java.lang.String sep, int from, int upto) Given an Array of Strings and a separator and a count, concat the first count elements of an array with separator between them.
static java.lang.String	locateFile(java.lang.String filename, java.lang.String abspath, boolean wantdir) Walk the specified subtree dir tree to try to locate file|dir named filename.
static java.lang.String	locateRelative(java.lang.String relpath, java.lang.String abspath, boolean wantdir) Walk the specified dir tree to locate file specified by relative path.
static long[]	longvector(int[] iv)
static java.lang.String	merge(java.lang.String[] pieces, java.lang.String sep)
static java.lang.String	nullify(java.lang.String path) Convert "" paths to null
static byte[]	readbinaryfile(java.io.InputStream stream)
static int	readbinaryfilepartial(java.io.InputStream stream, byte[] buffer, int count) Read a limited number of bytes from a stream
static java.lang.String	readtextfile(java.io.InputStream stream)
static java.lang.String	relativize(java.lang.String path)
static java.lang.String	repairPath(java.lang.String path) Convert a path of the form "/x:/" to "x:/" to expose drive letter; otherwise leave unchanged
static long	sliceProduct(java.util.List<Slice> slices)
static java.lang.Object	stringable(java.lang.Object obj) Convert null objects to ""
static java.lang.Integer	stringToInteger(java.lang.String s)
static java.lang.String	stripDap4Extensions(java.lang.String path)
static java.lang.String	xrelpath(java.lang.String path) Relativizing a path => remove any leading '/' and cleaning it

Methods inherited from class java.lang.Object

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

Field Detail

BIG_UMASK64

public static final java.math.BigInteger BIG_UMASK64

UTF8

public static final java.nio.charset.Charset UTF8

NETWORK_ORDER

public static final java.nio.ByteOrder NETWORK_ORDER

NATIVE_ORDER

public static final java.nio.ByteOrder NATIVE_ORDER

LF

public static final java.lang.String LF

See Also:

Constant Field Values

CRLF

public static final java.lang.String CRLF

See Also:

Constant Field Values

CRLFSIZE

public static final int CRLFSIZE

See Also:

Constant Field Values

DAP4EXT_RE

public static java.util.regex.Pattern DAP4EXT_RE

Constructor Detail

DapUtil

public DapUtil()

Method Detail

fqnSuffix

public static java.lang.String fqnSuffix(java.lang.String fqn)

fqnPrefix

public static java.lang.String fqnPrefix(java.lang.String fqn)

backslashSplit

public static java.util.List<java.lang.String> backslashSplit(java.lang.String s,
                                                              char sep)

Split a string with respect to a separator character and taking backslashes into consideration.

Parameters:

s - The string to split

sep - The character on which to split

Returns:

a List of strings (all with escaping still intact) representing s split at unescaped instances of sep.

stringToInteger

public static java.lang.Integer stringToInteger(java.lang.String s)

hasSequence

public static boolean hasSequence(DapNode node)

locateFile

public static java.lang.String locateFile(java.lang.String filename,
                                          java.lang.String abspath,
                                          boolean wantdir)

Walk the specified subtree dir tree to try to locate file|dir named filename. Use breadth first search.

Parameters:

filename - Name of the file|dir to locate

abspath - Absolute path from which to start search

wantdir - True if we are looking for a directory, false if we are looking for a file

Returns:

absolute path of the file or null

locateRelative

public static java.lang.String locateRelative(java.lang.String relpath,
                                              java.lang.String abspath,
                                              boolean wantdir)

Walk the specified dir tree to locate file specified by relative path. Use breadth first search.

Parameters:

relpath - Name of the file|dir to locate

abspath - Absolute path from which to start search

wantdir - True if we are looking for a directory, false if we are looking for a file

Returns:

absolute path of the file|dir wrt to abspath

canonicalpath

public static java.lang.String canonicalpath(java.lang.String path)

Convert path to: 1. use '/' consistently 2. remove any trailing '/' 3. trim blanks 4. Be aware of possible windows drive letter

Parameters:

path - convert this path

Returns:

canonicalized version

relativize

public static java.lang.String relativize(java.lang.String path)

absolutize

public static java.lang.String absolutize(java.lang.String path)

checkFixedSize

public static boolean checkFixedSize(DapVariable var)

extract

public static byte[] extract(java.nio.ByteBuffer buf)

Properly extract the byte contents of a ByteBuffer

Parameters:

buf - The buffer whose content is to be extracted as defined by the buffer limit.

Returns:

The byte array contents of the buffer

readbinaryfile

public static byte[] readbinaryfile(java.io.InputStream stream)
                             throws java.io.IOException

Throws:

java.io.IOException

readbinaryfilepartial

public static int readbinaryfilepartial(java.io.InputStream stream,
                                        byte[] buffer,
                                        int count)
                                 throws java.io.IOException

Read a limited number of bytes from a stream

Parameters:

stream -

buffer - into which to read

count - amount to read; <= |buffer|

Returns:

amount actually read

Throws:

java.io.IOException

readtextfile

public static java.lang.String readtextfile(java.io.InputStream stream)
                                     throws java.io.IOException

Throws:

java.io.IOException

getStructurePath

public static java.util.List<DapVariable> getStructurePath(DapVariable var)

Given a dap variable, get the path from the top-level variable to and including the given variable such that all but the last element is a structure.

denullify

public static java.lang.String denullify(java.lang.String path)

Convert null paths to ""

Parameters:

path -

Returns:

path or ""

stringable

public static java.lang.Object stringable(java.lang.Object obj)

Convert null objects to ""

Parameters:

obj -

Returns:

obj or ""

nullify

public static java.lang.String nullify(java.lang.String path)

Convert "" paths to null

Parameters:

path -

Returns:

path or null

getDimSizes

public static long[] getDimSizes(java.util.List<DapDimension> dims)

dimProduct

public static long dimProduct(java.util.List<DapDimension> dimset)

isWhole

public static boolean isWhole(java.util.List<Slice> slices,
                              java.util.List<DapDimension> dimset)

Test a List against set of DapDimensions to see if the list is whole wrt the dimensions

Parameters:

slices - the set of slices

dimset - the list of DapDimension

Returns:

true if slices is whole wrt dimset; false otherwise

sliceProduct

public static long sliceProduct(java.util.List<Slice> slices)

hasStrideOne

public static boolean hasStrideOne(java.util.List<Slice> slices)

join

public static java.lang.String join(java.lang.String[] array,
                                    java.lang.String sep,
                                    int from,
                                    int upto)

Given an Array of Strings and a separator and a count, concat the first count elements of an array with separator between them. A null string is treated like "".

Parameters:

array - the array to concat

sep - the separator

from - start point for join (inclusive)

upto - end point for join (exclusive)

Returns:

the join

xrelpath

public static java.lang.String xrelpath(java.lang.String path)

Relativizing a path => remove any leading '/' and cleaning it

Parameters:

path -

Returns:

Relativized path

hasDriveLetter

public static boolean hasDriveLetter(java.lang.String path)

Return true if this path appears to start with a windows drive letter This tests the patterns "/x:/" and "x:/"

Parameters:

path -

Returns:

true, if path has drive letter

repairPath

public static java.lang.String repairPath(java.lang.String path)

Convert a path of the form "/x:/" to "x:/" to expose drive letter; otherwise leave unchanged

Parameters:

path -

Returns:

repaired path

getProtocols

public static java.util.List<java.lang.String> getProtocols(java.lang.String url,
                                                            int[] breakpoint)

Return the set of leading protocols for a url; may be more than one.

Parameters:

url - the url whose protocols to return

breakpoint - return the index past last protocol

Returns:

list of leading protocols without the trailing :

merge

public static java.lang.String merge(java.lang.String[] pieces,
                                     java.lang.String sep)

checkruntime

public static void checkruntime(java.lang.Exception e)

Re-throw run-time exceptions

canonjoin

public static java.lang.String canonjoin(java.lang.String prefix,
                                         java.lang.String suffix)

hasWindowsDrive

public static boolean hasWindowsDrive(java.lang.String path)

isAbsolutePath

public static boolean isAbsolutePath(java.lang.String path)

canonFileURL

public static java.lang.String canonFileURL(java.lang.String url)

stripDap4Extensions

public static java.lang.String stripDap4Extensions(java.lang.String path)

isContiguous

public static boolean isContiguous(java.util.List<Slice> slices)

Test if a set of slices represent a contiguous region This is equivalent to saying all strides are one

Parameters:

slices -

Returns:

true, if contiguous

isSinglePoint

public static boolean isSinglePoint(java.util.List<Slice> slices)

Test if a set of slices represent a single position

Parameters:

slices -

Returns:

true, if single position

dimsetToSlices

public static java.util.List<Slice> dimsetToSlices(java.util.List<DapDimension> dimset)
                                            throws DapException

Throws:

DapException

isScalarSlices

public static boolean isScalarSlices(java.util.List<Slice> slices)

longvector

public static long[] longvector(int[] iv)

intvector

public static int[] intvector(long[] lv)