class NoaaNceiWeather::Dataset

Class for querying against the /datacategory endpoint of the NOAA API

Attributes

datacoverage[R]

@!attribute [r] id

@return [String] The unique Identifier, semi-readable

@!attribute [r] uid

@return [String] A second unique identifier used by NOAA

@!attribute [r] name

@return [String] The descriptive name

@!attribute [r] datacoverage

@return [Fixnum] The estimated completeness of data, value between 0 and 1

@!attribute [r] mindate

@return [Date] Earliest availability of data in this set

@!attribute [r] maxdate

@return [String] Latest availability of data in this set
maxdate[R]

@!attribute [r] id

@return [String] The unique Identifier, semi-readable

@!attribute [r] uid

@return [String] A second unique identifier used by NOAA

@!attribute [r] name

@return [String] The descriptive name

@!attribute [r] datacoverage

@return [Fixnum] The estimated completeness of data, value between 0 and 1

@!attribute [r] mindate

@return [Date] Earliest availability of data in this set

@!attribute [r] maxdate

@return [String] Latest availability of data in this set
mindate[R]

@!attribute [r] id

@return [String] The unique Identifier, semi-readable

@!attribute [r] uid

@return [String] A second unique identifier used by NOAA

@!attribute [r] name

@return [String] The descriptive name

@!attribute [r] datacoverage

@return [Fixnum] The estimated completeness of data, value between 0 and 1

@!attribute [r] mindate

@return [Date] Earliest availability of data in this set

@!attribute [r] maxdate

@return [String] Latest availability of data in this set
uid[R]

@!attribute [r] id

@return [String] The unique Identifier, semi-readable

@!attribute [r] uid

@return [String] A second unique identifier used by NOAA

@!attribute [r] name

@return [String] The descriptive name

@!attribute [r] datacoverage

@return [Fixnum] The estimated completeness of data, value between 0 and 1

@!attribute [r] mindate

@return [Date] Earliest availability of data in this set

@!attribute [r] maxdate

@return [String] Latest availability of data in this set

Public Class Methods

find(id) click to toggle source

Finds a specific instance of {DataCategory} by its ID

@param id [String] String ID of the resource. @return [Dataset, nil] Instance of {Dataset}, or nil if none found.

Calls superclass method
# File lib/noaa_ncei_weather/dataset.rb, line 90
def self.find(id)
  data = super(@@endpoint + "/#{id}")
  if data && data.any?
    self.new data['id'], data['uid'], data['name'], data['datacoverage'], Date.parse(data['mindate']), Date.parse(data['maxdate'])
  else
    nil
  end
end
new(id, uid, name, datacoverage, mindate, maxdate) click to toggle source

Creates new {DataType} object

Calls superclass method
# File lib/noaa_ncei_weather/dataset.rb, line 24
def initialize(id, uid, name, datacoverage, mindate, maxdate)
  super(id, name)
  @uid = uid
  @datacoverage = datacoverage
  @mindate = mindate
  @maxdate = maxdate
end
where(params = {}) click to toggle source

Finds a set of {Dataset Datasets} based on the parameters given

@param params [Hash] Hash to set filters on the request sent to the NOAA API @option params [String] :datatypeid String ID of a {DataType} @option params [DataType] :datatype {DataType} object @option params [String] :locationid String ID of a {Location} @option params [Location] :location {Location} object @option params [String] :stationid String ID of a {Station} @option params [Station] :station {Station} object @option params [Date, String] :startdate Date or ISO formmated string to

restrict data sets to those with data after this date

@option params [Date, String] :enddate Date or ISO formatted string to

restrict data sets to those with data before this date

@option params [String] :sortfield ('id') Accepts string values 'id', 'name,

'mindate', 'maxdate', and 'datacoverage' to sort data before being returned

@option params [String] :sortorder ('asc') Accepts 'asc' or 'desc' for sort order @option params [Integer] :limit Set a limit to the amount of records returned @option params [Integer] :offset (0) Used to offset the result list @return [Array<Dataset>] An array of {Dataset} objects

Calls superclass method
# File lib/noaa_ncei_weather/dataset.rb, line 118
def self.where(params = {})
  data = super(@@endpoint, params)
  if data && data.any?
    data.collect { |item| self.new item['id'], item['uid'], item['name'], item['datacoverage'], Date.parse(item['mindate']), Date.parse(item['maxdate']) }
  else
    []
  end
end

Public Instance Methods

data_categories(params = {}) click to toggle source

Retrieves the {DataCategory DataCategories} associated with this {Dataset}.

@param params [Hash] See {DataCategory.where} for valid key/values @return [Array<DataCategory>] An array of {DataCategory} objects associated

with this instance of {Dataset}
# File lib/noaa_ncei_weather/dataset.rb, line 37
def data_categories(params = {})
  params.merge!({datasetid: @id})
  DataCategory.where(params)
end
data_types(params = {}) click to toggle source

Retrieves the {DataType DataTypes} associated with this instance of {Dataset}. {Dataset} and {DataType} have a many to many relationship.

@param params [Hash] See {DataType.where} for valid key/values @return [Array<DataType>] An array of {DataType} objects associated with this

instance of {Dataset}
# File lib/noaa_ncei_weather/dataset.rb, line 48
def data_types(params = {})
  params.merge!({datasetid: @id})
  DataType.where(params)
end
location_categories(params = {}) click to toggle source

Retrieves the {LocationCategory LocationCategories} associated with this instance of {Dataset}. {Dataset} and {DataType} have a many to many relationship.

@param params [Hash] See {LocationCategory.where} for valid key/values. @return [Array<LocationCategory>] An array of {LocationCategory} objects associated

with this instance of {Dataset}.
# File lib/noaa_ncei_weather/dataset.rb, line 59
def location_categories(params = {})
  params.merge!({datasetid: @id})
  LocationCategory.where(params)
end
locations(params = {}) click to toggle source

Retrieves the {Location Locations} associated with this instance of {Dataset}. {Dataset} and {Location} have a many to many relationship.

@param params [Hash] See {Location.where} for valid key/values. @return [Array<Location>] An array of {Location} objects associated with

this instance of {Dataset}
# File lib/noaa_ncei_weather/dataset.rb, line 70
def locations(params = {})
  params.merge!({datasetid: @id})
  Location.where(params)
end
stations(params = {}) click to toggle source

Retrieves the {Station Stations} associated with this instance of {Dataset}. {Dataset} and {Station} have a many to many relationship

@param params [Hash] See {Station.where} for valid key/values. @return [Array<Station>] An array of {Station} objects associated with this

instance of {Dataset}.
# File lib/noaa_ncei_weather/dataset.rb, line 81
def stations(params = {})
  params.merge!({datasetid: @id})
  Station.where(params)
end