NeXusFileInterface.java

Go to the documentation of this file.

package org.nexusformat;

import java.util.Hashtable;

public interface NeXusFileInterface {

    // general functions
    public void flush() throws NexusException;

    public void finalize() throws Throwable;

    public void close() throws NexusException;

    // group functions
    public void makegroup(String name, String nxclass) throws 
                            NexusException;
    public void opengroup(String name, String nxclass) throws 
                             NexusException;
    public void openpath(String path) throws NexusException;

    public void opengrouppath(String path) throws NexusException;

    public String getpath() throws NexusException;

    public void closegroup() throws NexusException;

    // data set handling
    public void makedata(String name, int type, int rank, int dim[]) 
        throws NexusException;

    public void makedata(String name, int type, int rank, long dim[]) 
        throws NexusException;

    public void compmakedata(String name, int type, int rank, int dim[],
             int compression_type, int iChunk[]) throws NexusException; 

    public void compmakedata(String name, int type, int rank, long dim[],
             int compression_type, long iChunk[]) throws NexusException; 

    public void opendata(String name)throws NexusException;

    public void closedata() throws NexusException;

    public void compress(int compression_type) throws NexusException;

    // data set reading
    public void getdata(Object array) throws NexusException;

    public void getslab(int start[], int size[], Object array) throws
                          NexusException;

    public void getslab(long start[], long size[], Object array) throws
                          NexusException;

    public void getattr(String name, Object data, int args[]) throws
                          NexusException;

    // data set writing
    public void putdata(Object array) throws NexusException;

    public void putslab(Object array, int start[], int size[]) throws
                          NexusException;

    public void putslab(Object array, long start[], long size[]) throws
                          NexusException;

    public void putattr(String name, Object array, int iType) throws
                          NexusException;

    // inquiry
    public void getinfo(int iDim[], int args[]) throws NexusException;

    public void getinfo(long iDim[], int args[]) throws NexusException;

    public void setnumberformat(int type, String format) throws NexusException;

    public Hashtable groupdir() throws NexusException;

    public Hashtable attrdir() throws NexusException;
    
    // linking 
    public NXlink getgroupID() throws NexusException;

    public NXlink getdataID()throws NexusException;

    public void makelink(NXlink target)throws NexusException;     
    public void makenamedlink(String name, NXlink target) throws NexusException;     

    public void opensourcepath() throws NexusException;     

    public String inquirefile() throws NexusException;

    public void linkexternal(String name, String nxclass, String nxurl) throws NexusException;

    public void linkexternaldataset(String name, String nxurl) throws NexusException;

    public String isexternalgroup(String name, String nxclass) throws NexusException;

    public String isexternaldataset(String name) throws NexusException;
}