ucar.nc2.internal.ncml

Class AggDataset

java.lang.Object

ucar.nc2.internal.ncml.AggDataset

All Implemented Interfaces:

Comparable<AggDataset>

@Immutable
public class AggDataset
extends Object
implements Comparable<AggDataset>

Encapsolates a NetcdfFile, used by AggProxyReader.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cacheLocation
protected DatasetUrl	durl
protected MFile	mfile
protected FileFactory	reader
protected Object	spiObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggDataset(MFile mfile, Object spiObject, org.jdom2.Element ncmlElem)
protected	AggDataset(String cacheLocation, String location, String id, EnumSet<NetcdfDataset.Enhance> wantEnhance, FileFactory reader, Object spiObject, org.jdom2.Element ncmlElem) Dataset constructor.

Method Summary

Modifier and Type	Method and Description
NetcdfFile	acquireFile(CancelTask cancelTask)
protected void	cacheVariables(NetcdfFile ncfile)
protected void	close(NetcdfFile ncfile)
int	compareTo(AggDataset o)
boolean	equals(Object oo)
protected Variable	findVariable(NetcdfFile ncfile, Variable mainV)
String	getCacheLocation()
String	getId()
String	getLocation()
MFile	getMFile()
int	hashCode()
protected Array	read(Variable mainv, CancelTask cancelTask)
protected Array	read(Variable mainv, CancelTask cancelTask, List<Range> section) Read a section of the local Variable.
void	show(Formatter f)

Methods inherited from class java.lang.Object

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

Field Detail

mfile

@Nullable
protected final MFile mfile

cacheLocation

protected final String cacheLocation

reader

@Nullable
protected final FileFactory reader

spiObject

@Nullable
protected final Object spiObject

durl

protected DatasetUrl durl

Constructor Detail

AggDataset

protected AggDataset(MFile mfile,
                     @Nullable
                     Object spiObject,
                     @Nullable
                     org.jdom2.Element ncmlElem)

AggDataset

protected AggDataset(String cacheLocation,
                     @Nullable
                     String location,
                     @Nullable
                     String id,
                     @Nullable
                     EnumSet<NetcdfDataset.Enhance> wantEnhance,
                     @Nullable
                     FileFactory reader,
                     @Nullable
                     Object spiObject,
                     @Nullable
                     org.jdom2.Element ncmlElem)

Dataset constructor. With this constructor, the actual opening of the dataset is deferred, and done by the reader. Used with explicit netcdf elements, and scanned files.

Parameters:

cacheLocation - a unique name to use for caching

location - attribute "location" on the netcdf element

id - attribute "id" on the netcdf element

wantEnhance - open dataset in enhance mode, may be null

reader - factory for reading this netcdf dataset; if null, use NetcdfDatasets.open( location)

Method Detail

getLocation

public String getLocation()

getMFile

public MFile getMFile()

getCacheLocation

public String getCacheLocation()

getId

public String getId()

acquireFile

public NetcdfFile acquireFile(CancelTask cancelTask)
                       throws IOException

Throws:

IOException

close

protected void close(NetcdfFile ncfile)
              throws IOException

Throws:

IOException

cacheVariables

protected void cacheVariables(NetcdfFile ncfile)
                       throws IOException

Throws:

IOException

show

public void show(Formatter f)

read

protected Array read(Variable mainv,
                     CancelTask cancelTask)
              throws IOException

Throws:

IOException

read

protected Array read(Variable mainv,
                     CancelTask cancelTask,
                     List<Range> section)
              throws IOException,
                     InvalidRangeException

Read a section of the local Variable.

Parameters:

mainv - aggregated Variable

cancelTask - let user cancel

section - reletive to the local Variable

Returns:

the complete Array for mainv

Throws:

IOException - on I/O error

InvalidRangeException - on section error

findVariable

protected Variable findVariable(NetcdfFile ncfile,
                                Variable mainV)

equals

public boolean equals(Object oo)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(AggDataset o)

Specified by:

compareTo in interface Comparable<AggDataset>