Aggregation (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.nc2.internal.ncml.Aggregation

Direct Known Subclasses:

AggregationNew
```
public abstract class Aggregation
extends Object
```
Superclass for NcML Aggregation Builders. An Aggregation acts as a ProxyReader for VariableDS. That, is it must implement:
```
 public Array read(Variable mainv);
 
 public Array read(Variable mainv, Section section);
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class Aggregation.Type

protected static class Aggregation.TypicalDataset

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Aggregation.Type`
`protected static class`	`Aggregation.TypicalDataset`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`cacheDirty`
`static int`	`countCacheUse`
`protected MFileCollectionManager`	`datasetManager`
`protected List<AggDataset>`	`datasets`
`protected String`	`dateFormatMark`
`protected static boolean`	`debug`
`protected static boolean`	`debugConvert`
`protected static boolean`	`debugDateParse`
`protected static boolean`	`debugOpenFile`
`protected static boolean`	`debugProxy`
`protected static boolean`	`debugRead`
`protected static boolean`	`debugSyncDetail`
`protected String`	`dimName`
`protected static DiskCache2`	`diskCache2`
`protected static Executor`	`executor`
`protected List<AggDataset>`	`explicitDatasets`
`protected boolean`	`isDate`
`protected static org.slf4j.Logger`	`logger`
`protected NetcdfDataset.Builder<?>`	`ncDataset`
`protected Object`	`spiObject`
`protected Aggregation.Type`	`type`
`protected static Aggregation.TypicalDataset`	`typicalDatasetMode`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Aggregation(NetcdfDataset.Builder<?> ncd, String dimName, Aggregation.Type type, String recheckS)` Create an Aggregation for the given NetcdfDataset.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCollection(String spec, String olderThan)`
`void`	`addDataset(AggDataset nested)`
`void`	`addDatasetScan(org.jdom2.Element crawlableDatasetElement, String dirName, String suffix, String regexpPatternString, String dateFormatMark, Set<NetcdfDataset.Enhance> enhanceMode, String subdirs, String olderThan)` Add a dataset scan
`void`	`addExplicitDataset(String cacheName, String location, String id, String ncoordS, String coordValueS, String sectionSpec, FileFactory reader)` Add a nested dataset, specified by an explicit netcdf element.
`void`	`build(CancelTask cancelTask)`
`protected abstract void`	`buildNetcdfDataset(CancelTask cancelTask)` Call this to build the dataset objects in the NetcdfDataset
`void`	`close()`
`List<AggDataset>`	`getDatasets()`
`void`	`getDetailInfo(Formatter f)`
`String`	`getDimensionName()` Get dimension name to join on
`String`	`getFileTypeDescription()`
`String`	`getFileTypeId()`
`long`	`getLastModified()`
`protected String`	`getLocation()`
`Aggregation.Type`	`getType()` Get type of aggregation
`protected AggDataset`	`getTypicalDataset()` Open one of the nested datasets as a template for the aggregation dataset.
`protected AggDataset`	`makeDataset(MFile dset)`
`protected AggDataset`	`makeDataset(String cacheName, String location, String id, String ncoordS, String coordValueS, String sectionSpec, EnumSet<NetcdfDataset.Enhance> enhance, FileFactory reader)` Dataset factory, so subclasses can override
`protected void`	`makeDatasets(CancelTask cancelTask)` Make the list of Datasets, from explicit and scans.
`protected void`	`persistRead()` read info from the persistent XML file, if it exists; overridden in AggregationExisting
`void`	`persistWrite()` Allow information to be made persistent.
`static void`	`setExecutor(Executor exec)`
`void`	`setModifications(org.jdom2.Element ncmlMods)`
`static void`	`setPersistenceCache(DiskCache2 dc)`
`static void`	`setTypicalDatasetMode(String mode)`
`boolean`	`syncExtend()` Check to see if its time to rescan directory, and if so, rescan and extend dataset if needed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

typicalDatasetMode

protected static Aggregation.TypicalDataset typicalDatasetMode

logger

protected static org.slf4j.Logger logger

diskCache2
```
protected static DiskCache2 diskCache2
```

executor
```
protected static Executor executor
```

debug
```
protected static boolean debug
```

debugOpenFile
```
protected static boolean debugOpenFile
```

debugSyncDetail

protected static boolean debugSyncDetail

debugProxy
```
protected static boolean debugProxy
```

debugRead
```
protected static boolean debugRead
```

debugDateParse

protected static boolean debugDateParse

debugConvert
```
protected static boolean debugConvert
```

countCacheUse
```
public static int countCacheUse
```

ncDataset

protected NetcdfDataset.Builder<?> ncDataset

type
```
protected Aggregation.Type type
```

spiObject
```
protected Object spiObject
```

explicitDatasets

protected List<AggDataset> explicitDatasets

datasets
```
protected List<AggDataset> datasets
```

datasetManager

protected MFileCollectionManager datasetManager

cacheDirty
```
protected boolean cacheDirty
```

dimName
```
protected String dimName
```

dateFormatMark
```
protected String dateFormatMark
```

isDate
```
protected boolean isDate
```

Constructor Detail
- Aggregation
```
protected Aggregation(NetcdfDataset.Builder<?> ncd,
                      String dimName,
                      Aggregation.Type type,
                      String recheckS)
```
  Create an Aggregation for the given NetcdfDataset. The following addXXXX methods are called, then build(), before the object is ready for use.
  
  Parameters:
  
  ncd - Aggregation belongs to this NetcdfDataset
  
  dimName - the aggregation dimension name
  
  type - the Aggregation.Type
  
  recheckS - how often to check if files have changes

Method Detail

setPersistenceCache

public static void setPersistenceCache(DiskCache2 dc)

setExecutor

public static void setExecutor(Executor exec)

setTypicalDatasetMode

public static void setTypicalDatasetMode(String mode)

addExplicitDataset

public void addExplicitDataset(String cacheName,
                               String location,
                               String id,
                               String ncoordS,
                               String coordValueS,
                               String sectionSpec,
                               FileFactory reader)

Add a nested dataset, specified by an explicit netcdf element. enhance is handled by the reader, so its always false here.

Parameters:: cacheName - a unique name to use for caching; location - attribute "location" on the netcdf element; id - attribute "id" on the netcdf element; ncoordS - attribute "ncoords" on the netcdf element; coordValueS - attribute "coordValue" on the netcdf element; sectionSpec - attribute "section" on the netcdf element; reader - factory for reading this netcdf dataset

addDataset

public void addDataset(AggDataset nested)

addDatasetScan

public void addDatasetScan(org.jdom2.Element crawlableDatasetElement,
                           String dirName,
                           String suffix,
                           String regexpPatternString,
                           String dateFormatMark,
                           Set<NetcdfDataset.Enhance> enhanceMode,
                           String subdirs,
                           String olderThan)

Add a dataset scan

Parameters:: crawlableDatasetElement - defines a CrawlableDataset, or null; dirName - scan this directory; suffix - filter on this suffix (may be null); regexpPatternString - include if full name matches this regular expression (may be null); dateFormatMark - create dates from the filename (may be null); enhanceMode - how should files be enhanced; subdirs - equals "false" if should not descend into subdirectories; olderThan - files must be older than this time (now - lastModified >= olderThan); must be a time unit, may ne bull

addCollection

public void addCollection(String spec,
                          String olderThan)

setModifications

public void setModifications(org.jdom2.Element ncmlMods)

getType
```
public Aggregation.Type getType()
```
Get type of aggregation

Returns:

type of aggregation

getDimensionName
```
public String getDimensionName()
```
Get dimension name to join on

Returns:

dimension name or null if type union/tiled

getLocation
```
protected String getLocation()
```

close

public void close()
           throws IOException

Throws:: IOException

syncExtend
```
public boolean syncExtend()
```
Check to see if its time to rescan directory, and if so, rescan and extend dataset if needed. Note that this just calls sync(), so structural metadata may be modified (!!)

Returns:

true if directory was rescanned and dataset may have been updated

getLastModified
```
public long getLastModified()
```

getFileTypeId
```
public String getFileTypeId()
```

getFileTypeDescription

public String getFileTypeDescription()

buildNetcdfDataset
```
protected abstract void buildNetcdfDataset(CancelTask cancelTask)
                                    throws IOException
```
Call this to build the dataset objects in the NetcdfDataset

Parameters:

cancelTask - maybe cancel

Throws:

IOException - on read error

persistWrite
```
public void persistWrite()
                  throws IOException
```
Allow information to be made persistent. Overridden in AggregationExisting

Throws:

IOException - on error

persistRead
```
protected void persistRead()
```
read info from the persistent XML file, if it exists; overridden in AggregationExisting

getDetailInfo

public void getDetailInfo(Formatter f)

build

public void build(CancelTask cancelTask)
           throws IOException

Throws:: IOException

getDatasets
```
public List<AggDataset> getDatasets()
```

makeDatasets
```
protected void makeDatasets(CancelTask cancelTask)
```
Make the list of Datasets, from explicit and scans.

Parameters:

cancelTask - user can cancel

getTypicalDataset
```
protected AggDataset getTypicalDataset()
                                throws IOException
```
Open one of the nested datasets as a template for the aggregation dataset.

Returns:

a typical Dataset

Throws:

IOException - if there are no datasets

makeDataset

protected AggDataset makeDataset(String cacheName,
                                 String location,
                                 String id,
                                 String ncoordS,
                                 String coordValueS,
                                 String sectionSpec,
                                 EnumSet<NetcdfDataset.Enhance> enhance,
                                 FileFactory reader)

Dataset factory, so subclasses can override

Parameters:: cacheName - a unique name to use for caching; location - attribute "location" on the netcdf element; id - attribute "id" on the netcdf element; ncoordS - attribute "ncoords" on the netcdf element; coordValueS - attribute "coordValue" on the netcdf element; sectionSpec - attribute "sectionSpec" on the netcdf element; enhance - open dataset in enhance mode NOT USED; reader - factory for reading this netcdf dataset
Returns:: a Dataset

makeDataset

protected AggDataset makeDataset(MFile dset)

Class Aggregation

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

typicalDatasetMode

logger

diskCache2

executor

debug

debugOpenFile

debugSyncDetail

debugProxy

debugRead

debugDateParse

debugConvert

countCacheUse

ncDataset

type

spiObject

explicitDatasets

datasets

datasetManager

cacheDirty

dimName

dateFormatMark

isDate

Constructor Detail

Aggregation

Method Detail

setPersistenceCache

setExecutor

setTypicalDatasetMode

addExplicitDataset

addDataset

addDatasetScan

addCollection

setModifications

getType

getDimensionName

getLocation

close

syncExtend

getLastModified

getFileTypeId

getFileTypeDescription

buildNetcdfDataset

persistWrite

persistRead

getDetailInfo

build

getDatasets

makeDatasets

getTypicalDataset

makeDataset

makeDataset