ucar.multiarray
Interface RemoteAccessor

All Superinterfaces:
Accessor, java.rmi.Remote
All Known Implementing Classes:
RemoteAccessorImpl

public interface RemoteAccessor
extends Accessor, java.rmi.Remote

This interface is the same as Accessor, just tagged as java.rmi.Remote. This intervening layer is necessary so that the rmi compiler interpretes concrete multiarrays like MultiArrayImpl as return by value. Otherwise, if Accessor itself were remote, rmic would generate stubs for MultiArrayImpl to be a remote reference.

As of this writing (jdk1.1), the rmi compiler rmic is braindead in the sense that it doesn't recognize that java.rmi.RemoteException isa java.io.IOException. Hence, we reproduce each method declaration from Accessor, narrowing the throws specification.


Method Summary
 void copyin(int[] origin, MultiArray source)
          Aggregate write access.
 MultiArray copyout(int[] origin, int[] shape)
          Aggregate read access.
 java.lang.Object get(int[] index)
          Get (read) the array element at index.
 boolean getBoolean(int[] index)
          Get the array element at index, as a boolean.
 byte getByte(int[] index)
          Get the array element at index, as a byte.
 char getChar(int[] index)
          Get the array element at index, as a char.
 double getDouble(int[] index)
          Get the array element at index, as a double.
 float getFloat(int[] index)
          Get the array element at index, as a float.
 int getInt(int[] index)
          Get the array element at index, as an int.
 long getLong(int[] index)
          Get the array element at index, as a long.
 short getShort(int[] index)
          Get the array element at index, as a short.
 void set(int[] index, java.lang.Object value)
          Set (modify, write) the array element at index to the specified value.
 void setBoolean(int[] index, boolean value)
          Set the array element at index to the specified boolean value.
 void setByte(int[] index, byte value)
          Set the array element at index to the specified byte value.
 void setChar(int[] index, char value)
          Set the array element at index to the specified char value.
 void setDouble(int[] index, double value)
          Set the array element at index to the specified double value.
 void setFloat(int[] index, float value)
          Set the array element at index to the specified float value.
 void setInt(int[] index, int value)
          Set the array element at index to the specified int value.
 void setLong(int[] index, long value)
          Set the array element at index to the specified long value.
 void setShort(int[] index, short value)
          Set the array element at index to the specified short value.
 java.lang.Object toArray()
          Returns a new array containing all of the elements in this MultiArray.
 java.lang.Object toArray(java.lang.Object anArray, int[] origin, int[] shape)
          Returns an array containing elements of this MultiArray specified by origin and shape, possibly converting the component type.
 

Method Detail

get

java.lang.Object get(int[] index)
                     throws java.rmi.RemoteException
Description copied from interface: Accessor
Get (read) the array element at index. The returned value is wrapped in an object if it has a primitive type. Length of index must be greater than or equal to the rank of this. Values of index components must be less than corresponding values from getLengths().

Specified by:
get in interface Accessor
Parameters:
index - MultiArray index
Returns:
Object value at index
Throws:
java.rmi.RemoteException

getBoolean

boolean getBoolean(int[] index)
                   throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a boolean.

Specified by:
getBoolean in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getChar

char getChar(int[] index)
             throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a char.

Specified by:
getChar in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getByte

byte getByte(int[] index)
             throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a byte.

Specified by:
getByte in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getShort

short getShort(int[] index)
               throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a short.

Specified by:
getShort in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getInt

int getInt(int[] index)
           throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as an int.

Specified by:
getInt in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getLong

long getLong(int[] index)
             throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a long.

Specified by:
getLong in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getFloat

float getFloat(int[] index)
               throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a float.

Specified by:
getFloat in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

getDouble

double getDouble(int[] index)
                 throws java.rmi.RemoteException
Description copied from interface: Accessor
Get the array element at index, as a double.

Specified by:
getDouble in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.get(int[])

set

void set(int[] index,
         java.lang.Object value)
         throws java.rmi.RemoteException
Description copied from interface: Accessor
Set (modify, write) the array element at index to the specified value. If the array has a primitive component type, the value may be unwrapped. Values of index components must be less than corresponding values from getLengths().

Specified by:
set in interface Accessor
Parameters:
index - MultiArray index
value - the new value.
Throws:
java.rmi.RemoteException

setBoolean

void setBoolean(int[] index,
                boolean value)
                throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified boolean value.

Specified by:
setBoolean in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setChar

void setChar(int[] index,
             char value)
             throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified char value.

Specified by:
setChar in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setByte

void setByte(int[] index,
             byte value)
             throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified byte value.

Specified by:
setByte in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setShort

void setShort(int[] index,
              short value)
              throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified short value.

Specified by:
setShort in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setInt

void setInt(int[] index,
            int value)
            throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified int value.

Specified by:
setInt in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setLong

void setLong(int[] index,
             long value)
             throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified long value.

Specified by:
setLong in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setFloat

void setFloat(int[] index,
              float value)
              throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified float value.

Specified by:
setFloat in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

setDouble

void setDouble(int[] index,
               double value)
               throws java.rmi.RemoteException
Description copied from interface: Accessor
Set the array element at index to the specified double value.

Specified by:
setDouble in interface Accessor
Throws:
java.rmi.RemoteException
See Also:
Accessor.set(int[], java.lang.Object)

copyout

MultiArray copyout(int[] origin,
                   int[] shape)
                   throws java.rmi.RemoteException
Description copied from interface: Accessor
Aggregate read access. Return a new MultiArray of the same componentType as this, and with shape as specified, which is initialized to the values of this, as clipped to (origin, origin + shape).

It is easier to implement than to specify :-).

The main reason to implement this instead of using the equivalent proxy is for remote or file access.

assert(origin[ii] + shape[ii] <= lengths[ii]);

Specified by:
copyout in interface Accessor
Parameters:
origin - int array specifying the starting index.
shape - int array specifying the extents in each dimension. This becomes the shape of the return.
Returns:
the MultiArray with the specified shape
Throws:
java.rmi.RemoteException

copyin

void copyin(int[] origin,
            MultiArray source)
            throws java.rmi.RemoteException
Description copied from interface: Accessor
Aggregate write access. Given a MultiArray, copy it into this at the specified starting index. TODO: clearer specification.

Hopefully this member can be optimized in various situations.

assert(origin[ii] + (source.getLengths())[ii] <= (getLengths())[ii]);

Specified by:
copyin in interface Accessor
Parameters:
origin - int array specifying the starting index.
source - MultiArray with the same componentType as this and shape smaller than this.getLengths() - origin
Throws:
java.rmi.RemoteException

toArray

java.lang.Object toArray()
                         throws java.rmi.RemoteException
Description copied from interface: Accessor
Returns a new array containing all of the elements in this MultiArray. The returned array is one dimensional. The order of the elements in the result is natural, as if we used an IndexIterator to step through the elements of this MultiArray. The component type of the result is the same as this.

This method acts as bridge between array-based and MultiArray-based APIs.

This method is functionally equivalent to

                Object anArray = Array.newInstance(getComponentType(), 1);
                int [] origin = new int[getRank()]
                int [] shape = getDimensions();
                return toArray(anArray, origin, shape);
 

Specified by:
toArray in interface Accessor
Returns:
a one dimensional Array containing all the elements in this MultiArray
Throws:
java.rmi.RemoteException

toArray

java.lang.Object toArray(java.lang.Object anArray,
                         int[] origin,
                         int[] shape)
                         throws java.rmi.RemoteException
Description copied from interface: Accessor
Returns an array containing elements of this MultiArray specified by origin and shape, possibly converting the component type. The returned array is one dimensional. The order of the elements in the result is natural, as if we used an IndexIterator to step through the elements of this MultiArray.

The anArray argument should be an array. If it is large enough to contain the output, it is used and no new storage is allocated. Otherwise, new storage is allocated with the same component type as the argument, and the data is copied into it.

This method acts as bridge between array-based and MultiArray-based APIs.

This method is similar to copyout(origin, shape).toArray(), but avoids a copy operation and (potentially) an allocation.

NOTE: Implementation of type conversion is deferred until JDK 1.2. Currently, the componentType of anArray must be the same as this

Specified by:
toArray in interface Accessor
Returns:
a one dimensional Array containing the specified elements
Throws:
java.rmi.RemoteException