Package org.bedework.timezones.common

Interface CachedData

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractCachedData, AbstractDb, FileCachedData, H2dbCachedData, ZipCachedData
public interface CachedData extends Serializable
Cached data affected by the source data.
Author:
douglm

  • Method Details

    • stop

      void stop() throws TzException
      Stop any running threads.
      Throws:
      TzException - on fatal error

    • getSource

      String getSource() throws TzException
      Returns:
      String source information for data.
      Throws:
      TzException - on fatal error

    • getStats

      List<Stat> getStats() throws TzException
      Returns:
      stats for the module
      Throws:
      TzException - on fatal error

    • checkData

      void checkData() throws TzException
      Update from primary source if any.
      Throws:
      TzException - on fatal error

    • updateData

      void updateData(String dtstamp, List<Differ.DiffListEntry> dles) throws TzException
      Update the stored data using the given update list. Note that the update may be transient if the data cache has no or an unchangable backing.
      Parameters:
      dtstamp - lastmod for change
      dles - diff list
      Throws:
      TzException - on fatal error

    • getDtstamp

      String getDtstamp() throws TzException
      Returns:
      XML formatted UTC dateTime
      Throws:
      TzException - on fatal error

    • fromAlias

      String fromAlias(String val)
      Given an alias return the tzid for that alias
      Parameters:
      val - alias
      Returns:
      aliased name or null

    • getAliasesStr

      String getAliasesStr() throws TzException
      Returns:
      String value of aliases file.
      Throws:
      TzException - on fatal error

    • findAliases

      SortedSet<String> findAliases(String tzid) throws TzException
      Parameters:
      tzid - for which we want aliases
      Returns:
      list of aliases or null
      Throws:
      TzException - on fatal error

    • getNameList

      SortedSet<String> getNameList() throws TzException
      Returns:
      namelist or null
      Throws:
      TzException - on fatal error

    • setExpanded

      void setExpanded(ExpandedMapEntryKey key, ExpandedMapEntry tzs) throws TzException
      Parameters:
      key - to expanded map
      tzs - entries from map
      Throws:
      TzException - on fatal error

    • getExpanded

      ExpandedMapEntry getExpanded(ExpandedMapEntryKey key) throws TzException
      Parameters:
      key - to expanded map
      Returns:
      expanded or null
      Throws:
      TzException - on fatal error

    • getCachedVtz

      String getCachedVtz(String name) throws TzException
      Get cached VTIMEZONE specifications
      Parameters:
      name - tzid
      Returns:
      cached spec or null.
      Throws:
      TzException - on fatal error

    • getAllCachedVtzs

      Collection<String> getAllCachedVtzs() throws TzException
      Get all cached VTIMEZONE specifications
      Returns:
      cached specs or null.
      Throws:
      TzException - on fatal error

    • getTimeZone

      net.fortuna.ical4j.model.TimeZone getTimeZone(String tzid) throws TzException
      Get a timezone object from the server given the id.
      Parameters:
      tzid - the id
      Returns:
      TimeZone with id or null
      Throws:
      TzException - on fatal error

    • getXTimeZone

      IcalendarType getXTimeZone(String tzid) throws TzException
      Get a timezone object from the server given the id.
      Parameters:
      tzid - the id
      Returns:
      IcalendarType with id or null
      Throws:
      TzException - on fatal error

    • getAliasedXTimeZone

      IcalendarType getAliasedXTimeZone(String tzid) throws TzException
      Get an aliased timezone object from the server given the id.
      Parameters:
      tzid - the id
      Returns:
      IcalendarType with id or null
      Throws:
      TzException - on fatal error

    • getAliasedCachedVtz

      String getAliasedCachedVtz(String name) throws TzException
      Get an aliased cached VTIMEZONE specifications
      Parameters:
      name - tzid
      Returns:
      cached spec or null.
      Throws:
      TzException - on fatal error

    • getTimezones

      List<org.bedework.util.timezones.model.TimezoneType> getTimezones(String[] tzids) throws TzException
      Parameters:
      tzids - - to fetch
      Returns:
      list of summary info
      Throws:
      TzException - on fatal error

    • getTimezones

      List<org.bedework.util.timezones.model.TimezoneType> getTimezones(String changedSince) throws TzException
      Parameters:
      changedSince - - null or dtstamp value
      Returns:
      list of summary info
      Throws:
      TzException - on fatal error

    • findTimezones

      List<org.bedework.util.timezones.model.TimezoneType> findTimezones(String name) throws TzException
      Parameters:
      name - to be partially matched
      Returns:
      list of matching summary info
      Throws:
      TzException - on fatal error