DapUtil (d4core 5.5.0-SNAPSHOT API)

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

public abstract class DapUtil
extends Object

Misc. Utility methods

Field Summary

Fields
Modifier and Type	Field and Description
`static BigInteger`	`BIG_UMASK64`
`static String`	`CEATTRNAME`
`static String`	`CHECKSUMATTRNAME`
`static int`	`CHECKSUMSIZE`
`static int`	`CHUNK_ALL`
`static int`	`CHUNK_DATA`
`static int`	`CHUNK_END`
`static int`	`CHUNK_ERROR`
`static int`	`CHUNK_LITTLE_ENDIAN`
`static int`	`CHUNK_NOCHECKSUM`
`static String`	`CRLF`
`static int`	`CRLFSIZE`
`static String`	`DIGESTER`
`static String`	`DRIVELETTERS`
`static String`	`LF`
`static String`	`LITTLEENDIANATTRNAME`
`static ByteOrder`	`NATIVE_ORDER`
`static ByteOrder`	`NETWORK_ORDER`
`static Charset`	`UTF8`

Constructor Summary

Constructors
Constructor and Description

DapUtil()

Constructors
Constructor and Description
`DapUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`absolutize(String path)`
`static List<String>`	`backslashSplit(String s, char sep)` Split a string with respect to a separator character and taking backslashes into consideration.
`static String`	`canonFileURL(String url)`
`static String`	`canonicalpath(String path)` Convert path to: 1.
`static String`	`canonjoin(String prefix, String suffix)`
`static boolean`	`checkFixedSize(DapVariable var)`
`static void`	`checkruntime(Exception e)` Re-throw run-time exceptions
`static String`	`denullify(String path)` Convert null paths to ""
`static long`	`dimProduct(List<DapDimension> dimset)`
`static List<Slice>`	`dimsetToSlices(List<DapDimension> dimset)`
`static byte[]`	`extract(ByteBuffer buf)` Properly extract the byte contents of a ByteBuffer
`static String`	`fqnPrefix(String fqn)`
`static String`	`fqnSuffix(String fqn)`
`static long[]`	`getDimSizes(List<DapDimension> dims)`
`static List<String>`	`getProtocols(String url, int[] breakpoint)` Return the set of leading protocols for a url; may be more than one.
`static 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(String path)` return true if this path appears to start with a windows drive letter
`static boolean`	`hasSequence(DapNode node)`
`static boolean`	`hasStrideOne(List<Slice> slices)`
`static boolean`	`hasWindowsDrive(String path)`
`static List<Slice>`	`indexToSlices(Index indices)` Given an offset (single index) and a set of dimensions compute the set of dimension indices that correspond to the offset.
`static List<Slice>`	`indexToSlices(Index indices, DapVariable template)` Provide a helper function to convert an Index object to a slice list.
`static List<Slice>`	`indexToSlices(Index indices, List<DapDimension> dimset)`
`static boolean`	`isAbsolutePath(String path)`
`static boolean`	`isContiguous(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(List<Slice> slices)`
`static boolean`	`isSinglePoint(List<Slice> slices)` Test if a set of slices represent a single position
`static boolean`	`isWhole(List<Slice> slices, List<DapDimension> dimset)` Test a List against set of DapDimensions to see if the list is whole wrt the dimensions
`static String`	`join(String[] array, 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 String`	`locateFile(String filename, String abspath, boolean wantdir)` Walk the specified subtree dir tree to try to locate file\|dir named filename.
`static String`	`locateRelative(String relpath, String abspath, boolean wantdir)` Walk the specified dir tree to locate file specified by relative path.
`static String`	`merge(String[] pieces, String sep)`
`static String`	`nullify(String path)` Convert "" paths to null
`static Index`	`offsetToIndex(long offset, long[] dimsizes)` Given an offset (single index) and a set of dimensions compute the set of dimension indices that correspond to the offset.
`static List<Slice>`	`offsetToSlices(long offset, DapVariable template)` Provide a helper function to convert an offset to a slice list.
`static byte[]`	`readbinaryfile(InputStream stream)`
`static String`	`readtextfile(InputStream stream)`
`static String`	`relativize(String path)`
`static long`	`sliceProduct(List<Slice> slices)`
`static Index`	`slicesToIndex(List<Slice> slices)` If a set of slices refers to a single position, then return the corresponding Index.
`static Integer`	`stringToInteger(String s)`
`static String`	`xrelpath(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 BigInteger BIG_UMASK64
```
  - UTF8
```
public static final Charset UTF8
```
  - NETWORK_ORDER
```
public static final ByteOrder NETWORK_ORDER
```
  - NATIVE_ORDER
```
public static final ByteOrder NATIVE_ORDER
```
  - CHUNK_DATA
```
public static final int CHUNK_DATA
```
    See Also:
    
    Constant Field Values
  - CHUNK_END
```
public static final int CHUNK_END
```
    See Also:
    
    Constant Field Values
  - CHUNK_ERROR
```
public static final int CHUNK_ERROR
```
    See Also:
    
    Constant Field Values
  - CHUNK_LITTLE_ENDIAN
```
public static final int CHUNK_LITTLE_ENDIAN
```
    See Also:
    
    Constant Field Values
  - CHUNK_NOCHECKSUM
```
public static final int CHUNK_NOCHECKSUM
```
    See Also:
    
    Constant Field Values
  - CHUNK_ALL
```
public static final int CHUNK_ALL
```
    See Also:
    
    Constant Field Values
  - LF
```
public static final String LF
```
    See Also:
    
    Constant Field Values
  - CRLF
```
public static final String CRLF
```
    See Also:
    
    Constant Field Values
  - CRLFSIZE
```
public static final int CRLFSIZE
```
    See Also:
    
    Constant Field Values
  - CHECKSUMSIZE
```
public static final int CHECKSUMSIZE
```
    See Also:
    
    Constant Field Values
  - DIGESTER
```
public static final String DIGESTER
```
    See Also:
    
    Constant Field Values
  - CHECKSUMATTRNAME
```
public static final String CHECKSUMATTRNAME
```
    See Also:
    
    Constant Field Values
  - LITTLEENDIANATTRNAME
```
public static final String LITTLEENDIANATTRNAME
```
    See Also:
    
    Constant Field Values
  - CEATTRNAME
```
public static final String CEATTRNAME
```
    See Also:
    
    Constant Field Values
  - DRIVELETTERS
```
public static final String DRIVELETTERS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DapUtil
```
public DapUtil()
```
- Method Detail
  - fqnSuffix
```
public static String fqnSuffix(String fqn)
```
  - fqnPrefix
```
public static String fqnPrefix(String fqn)
```
  - backslashSplit
```
public static List<String> backslashSplit(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 Integer stringToInteger(String s)
```
  - hasSequence
```
public static boolean hasSequence(DapNode node)
```
  - locateFile
```
public static String locateFile(String filename,
                                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 String locateRelative(String relpath,
                                    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 String canonicalpath(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 String relativize(String path)
```
  - absolutize
```
public static String absolutize(String path)
```
  - checkFixedSize
```
public static boolean checkFixedSize(DapVariable var)
```
  - extract
```
public static byte[] extract(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(InputStream stream)
                             throws IOException
```
    Throws:
    
    IOException
  - readtextfile
```
public static String readtextfile(InputStream stream)
                           throws IOException
```
    Throws:
    
    IOException
  - getStructurePath
```
public static 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 String denullify(String path)
```
    Convert null paths to ""
    
    Parameters:
    
    path -
    
    Returns:
    
    path or ""
  - nullify
```
public static String nullify(String path)
```
    Convert "" paths to null
    
    Parameters:
    
    path -
    
    Returns:
    
    path or null
  - getDimSizes
```
public static long[] getDimSizes(List<DapDimension> dims)
```
  - dimProduct
```
public static long dimProduct(List<DapDimension> dimset)
```
  - isWhole
```
public static boolean isWhole(List<Slice> slices,
                              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(List<Slice> slices)
```
  - hasStrideOne
```
public static boolean hasStrideOne(List<Slice> slices)
```
  - join
```
public static String join(String[] array,
                          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 String xrelpath(String path)
```
    Relativizing a path => remove any leading '/' and cleaning it
    
    Parameters:
    
    path -
    
    Returns:
    
    Relativized path
  - hasDriveLetter
```
public static boolean hasDriveLetter(String path)
```
    return true if this path appears to start with a windows drive letter
    
    Parameters:
    
    path -
    
    Returns:
    
    true, if path has drive letter
  - getProtocols
```
public static List<String> getProtocols(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 String merge(String[] pieces,
                           String sep)
```
  - checkruntime
```
public static void checkruntime(Exception e)
```
    Re-throw run-time exceptions
  - canonjoin
```
public static String canonjoin(String prefix,
                               String suffix)
```
  - hasWindowsDrive
```
public static boolean hasWindowsDrive(String path)
```
  - isAbsolutePath
```
public static boolean isAbsolutePath(String path)
```
  - canonFileURL
```
public static String canonFileURL(String url)
```
  - indexToSlices
```
public static List<Slice> indexToSlices(Index indices,
                                        DapVariable template)
                                 throws DapException
```
    Provide a helper function to convert an Index object to a slice list.
    
    Parameters:
    
    indices - indicate value to read
    
    template - variable template
    
    Returns:
    
    corresponding List
    
    Throws:
    
    DapException
  - indexToSlices
```
public static List<Slice> indexToSlices(Index indices,
                                        List<DapDimension> dimset)
                                 throws DapException
```
    Throws:
    
    DapException
  - offsetToSlices
```
public static List<Slice> offsetToSlices(long offset,
                                         DapVariable template)
                                  throws DapException
```
    Provide a helper function to convert an offset to a slice list.
    
    Parameters:
    
    offset - offset
    
    template - variable template
    
    Returns:
    
    slices
    
    Throws:
    
    DapException
  - offsetToIndex
```
public static Index offsetToIndex(long offset,
                                  long[] dimsizes)
```
    Given an offset (single index) and a set of dimensions compute the set of dimension indices that correspond to the offset.
  - indexToSlices
```
public static List<Slice> indexToSlices(Index indices)
                                 throws DapException
```
    Given an offset (single index) and a set of dimensions compute the set of dimension indices that correspond to the offset.
    
    Throws:
    
    DapException
  - isContiguous
```
public static boolean isContiguous(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(List<Slice> slices)
```
    Test if a set of slices represent a single position
    
    Parameters:
    
    slices -
    
    Returns:
    
    true, if single position
  - slicesToIndex
```
public static Index slicesToIndex(List<Slice> slices)
                           throws DapException
```
    If a set of slices refers to a single position, then return the corresponding Index. Otherwise, throw Exception.
    
    Parameters:
    
    slices -
    
    Returns:
    
    Index corresponding to slices
    
    Throws:
    
    DapException
  - dimsetToSlices
```
public static List<Slice> dimsetToSlices(List<DapDimension> dimset)
                                  throws DapException
```
    Throws:
    
    DapException
  - isScalarSlices
```
public static boolean isScalarSlices(List<Slice> slices)
```

Class DapUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BIG_UMASK64

UTF8

NETWORK_ORDER

NATIVE_ORDER

CHUNK_DATA

CHUNK_END

CHUNK_ERROR

CHUNK_LITTLE_ENDIAN

CHUNK_NOCHECKSUM

CHUNK_ALL

LF

CRLF

CRLFSIZE

CHECKSUMSIZE

DIGESTER

CHECKSUMATTRNAME

LITTLEENDIANATTRNAME

CEATTRNAME

DRIVELETTERS

Constructor Detail

DapUtil

Method Detail

fqnSuffix

fqnPrefix

backslashSplit

stringToInteger

hasSequence

locateFile

locateRelative

canonicalpath

relativize

absolutize

checkFixedSize

extract

readbinaryfile

readtextfile

getStructurePath

denullify

nullify

getDimSizes

dimProduct

isWhole

sliceProduct

hasStrideOne

join

xrelpath

hasDriveLetter

getProtocols

merge

checkruntime

canonjoin

hasWindowsDrive

isAbsolutePath

canonFileURL

indexToSlices

indexToSlices

offsetToSlices

offsetToIndex

indexToSlices

isContiguous

isSinglePoint

slicesToIndex

dimsetToSlices

isScalarSlices