NeXusJavaBindings  1
 All Classes Namespaces Files Functions Variables Typedefs Macros Pages
NeXusFileInterface.java
Go to the documentation of this file.
1 
17 package org.nexusformat;
18 
19 import java.util.Hashtable;
20 
21 public interface NeXusFileInterface {
22 
23  // general functions
29  public void flush() throws NexusException;
30 
40  public void finalize() throws Throwable;
41 
46  public void close() throws NexusException;
47 
48  // group functions
56  public void makegroup(String name, String nxclass) throws
66  public void opengroup(String name, String nxclass) throws
76  public void openpath(String path) throws NexusException;
77 
86  public void opengrouppath(String path) throws NexusException;
87 
93  public String getpath() throws NexusException;
94 
101  public void closegroup() throws NexusException;
102 
103  // data set handling
116  public void makedata(String name, int type, int rank, int dim[])
117  throws NexusException;
118 
131  public void makedata(String name, int type, int rank, long dim[])
132  throws NexusException;
133 
151  public void compmakedata(String name, int type, int rank, int dim[],
152  int compression_type, int iChunk[]) throws NexusException;
153 
171  public void compmakedata(String name, int type, int rank, long dim[],
172  int compression_type, long iChunk[]) throws NexusException;
173 
181  public void opendata(String name)throws NexusException;
182 
188  public void closedata() throws NexusException;
189 
199  public void compress(int compression_type) throws NexusException;
200 
201  // data set reading
212  public void getdata(Object array) throws NexusException;
213 
225  public void getslab(int start[], int size[], Object array) throws
227 
239  public void getslab(long start[], long size[], Object array) throws
241 
254  public void getattr(String name, Object data, int args[]) throws
256 
257  // data set writing
264  public void putdata(Object array) throws NexusException;
265 
276  public void putslab(Object array, int start[], int size[]) throws
278 
289  public void putslab(Object array, long start[], long size[]) throws
291 
300  public void putattr(String name, Object array, int iType) throws
302 
303  // inquiry
313  public void getinfo(int iDim[], int args[]) throws NexusException;
314 
324  public void getinfo(long iDim[], int args[]) throws NexusException;
325 
335  public void setnumberformat(int type, String format) throws NexusException;
336 
345  public Hashtable groupdir() throws NexusException;
346 
354  public Hashtable attrdir() throws NexusException;
355 
356  // linking
363  public NXlink getgroupID() throws NexusException;
364 
371  public NXlink getdataID()throws NexusException;
372 
379  public void makelink(NXlink target)throws NexusException;
388  public void makenamedlink(String name, NXlink target) throws NexusException;
389 
395  public void opensourcepath() throws NexusException;
396 
403  public String inquirefile() throws NexusException;
404 
412  public void linkexternal(String name, String nxclass, String nxurl) throws NexusException;
413 
420  public void linkexternaldataset(String name, String nxurl) throws NexusException;
421 
430  public String isexternalgroup(String name, String nxclass) throws NexusException;
431 
439  public String isexternaldataset(String name) throws NexusException;
440 }