BEAST
eu.baltrad.beast.rules.gra.GraRule Class Reference
Inheritance diagram for eu.baltrad.beast.rules.gra.GraRule:
eu.baltrad.beast.rules.acrr.AcrrRule eu.baltrad.beast.rules.IRule

Public Member Functions

String getType ()
 
IBltMessage handle (IBltMessage message)
 
int getFirstTermUTC ()
 Returns the offset in hours to the first observation term.
 
void setFirstTermUTC (int firstTermUTC)
 Sets the offset in hours to the first observation term.
 
int getInterval ()
 The interval for each term.
 
void setInterval (int interval)
 The interval of which we can use as periods.
 
void setHours (int hours)
 Same definition as setInterval(int).
 
int getHours ()
 Same definition as getHours().
 
- Public Member Functions inherited from eu.baltrad.beast.rules.acrr.AcrrRule
void setCatalog (Catalog catalog)
 
Catalog getCatalog ()
 
void setRuleUtilities (IRuleUtilities ruleUtil)
 
IRuleUtilities getRuleUtilities ()
 
void setRuleId (int ruleid)
 
int getRuleId ()
 
void setArea (String area)
 
String getArea ()
 
double getZrA ()
 
void setZrA (double zrA)
 
double getZrB ()
 
void setZrB (double zrB)
 
int getFilesPerHour ()
 The files included / hour.
 
void setFilesPerHour (int filesPerHour)
 Sets the number of in-products / hour.
 
String getObjectType ()
 The object type, either COMP or IMAGE.
 
void setObjectType (String objectType)
 
int getAcceptableLoss ()
 The acceptable loss / pixel when generating the acrr product.
 
void setAcceptableLoss (int acceptableLoss)
 The acceptable loss when generating a product.
 
String getDistancefield ()
 The distance field to use in the product generation.
 
void setDistancefield (String distancefield)
 Sets the distance quality field.
 
String getQuantity ()
 
void setQuantity (String quantity)
 
void afterPropertiesSet () throws Exception
 
boolean isValid ()
 
boolean isApplyGRA ()
 
void setApplyGRA (boolean applyGRA)
 
String getProductId ()
 
void setProductId (String productId)
 
IFilter getFilter ()
 
void setFilter (IFilter filter)
 
MetadataMatcher getMatcher ()
 
void setMatcher (MetadataMatcher matcher)
 

Static Public Attributes

static final String TYPE = "blt_gra"
 The name of this static acrr type.
 
- Static Public Attributes inherited from eu.baltrad.beast.rules.acrr.AcrrRule
static final String TYPE = "blt_acrr"
 The name of this static acrr type.
 

Protected Member Functions

List< CatalogEntryfindFiles (DateTime now)
 Returns a filtered list of all included files from now and hours backward.
 
DateTime getNominalTime (DateTime now)
 Returns the nearest lowest start of period from now.
 
DateTime getNowDT ()
 Basically here for testing purposes.
 
- Protected Member Functions inherited from eu.baltrad.beast.rules.acrr.AcrrRule
 AcrrRule ()
 Constructor.
 
List< CatalogEntryfilterEntries (List< CatalogEntry > entries)
 Filters the entries so that only one date-time / slot occurs.
 
List< CatalogEntryfilterEntries (List< CatalogEntry > entries, Map< DateTime, CatalogEntry > validEntries)
 Creates a new list of entries where the entry must exist in both entries and validEntries.
 
int compareStoredDateTime (CatalogEntry e1, CatalogEntry e2)
 Compares the stored date time between catalog entry 1 and 2.
 
boolean isLessOrEqual (DateTime d1, DateTime d2)
 Returns true if d1 is <= d2, otherwise false.
 
TimeSelectionFilter createFilter (DateTime sdt, DateTime edt, int interval)
 Creates the time selection filter to be used in this generation.
 
int getFilesPerHourInterval ()
 Returns the interval corresponding to the number of files / hour.
 

Detailed Description

Author
Anders Henja

Member Function Documentation

◆ findFiles()

List< CatalogEntry > eu.baltrad.beast.rules.gra.GraRule.findFiles ( DateTime now)
inlineprotected

Returns a filtered list of all included files from now and hours backward.

The filtered list will only contain one file / what_time, what_date and the files will be based on latest stored_time.

Parameters
nowthe current time
Returns
the found unique entries.

Reimplemented from eu.baltrad.beast.rules.acrr.AcrrRule.

◆ getFirstTermUTC()

int eu.baltrad.beast.rules.gra.GraRule.getFirstTermUTC ( )
inline

Returns the offset in hours to the first observation term.

This is the time when the term ends.

Returns
the offset in hours

◆ getHours()

int eu.baltrad.beast.rules.gra.GraRule.getHours ( )
inline

Same definition as getHours().

Reimplemented from eu.baltrad.beast.rules.acrr.AcrrRule.

◆ getInterval()

int eu.baltrad.beast.rules.gra.GraRule.getInterval ( )
inline

The interval for each term.

This will always be the same as hours but it is only allowed to have the same values as the interval.

Returns
the interval

◆ getNominalTime()

DateTime eu.baltrad.beast.rules.gra.GraRule.getNominalTime ( DateTime now)
inlineprotected

Returns the nearest lowest start of period from now.

For example, if interval = 6, firstTermUTC = 6 and now.hour() = 7, then returned date will be one hour lower than now.

Parameters
nownow
Returns
first previous start of period from now

◆ getNowDT()

DateTime eu.baltrad.beast.rules.gra.GraRule.getNowDT ( )
inlineprotected

Basically here for testing purposes.

Returns
now as date time object

◆ getType()

String eu.baltrad.beast.rules.gra.GraRule.getType ( )
inline

◆ handle()

IBltMessage eu.baltrad.beast.rules.gra.GraRule.handle ( IBltMessage message)
inline

◆ setFirstTermUTC()

void eu.baltrad.beast.rules.gra.GraRule.setFirstTermUTC ( int firstTermUTC)
inline

Sets the offset in hours to the first observation term.

This is the time when the term ends.

Parameters
firstTermUTCthe offset in hours

◆ setHours()

void eu.baltrad.beast.rules.gra.GraRule.setHours ( int hours)
inline

Same definition as setInterval(int).

Reimplemented from eu.baltrad.beast.rules.acrr.AcrrRule.

◆ setInterval()

void eu.baltrad.beast.rules.gra.GraRule.setInterval ( int interval)
inline

The interval of which we can use as periods.

This overrides the hours setting.

Parameters
intervalthe interval, must be evenly dividable by 24. I.e. 1,2,3,4,6,8,12 and 24

Member Data Documentation

◆ TYPE

final String eu.baltrad.beast.rules.gra.GraRule.TYPE = "blt_gra"
static

The name of this static acrr type.


The documentation for this class was generated from the following file: