Class: Rubyfb::Row

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/src.rb

Overview

This class models a row of data fetched as part of a SQL query.

Instance Method Summary collapse

Constructor Details

#initialize(results, data, number) ⇒ Row

This is the constructor for the Row class. This method shouldn’t really be used as Row objects are automatically created by ResultSets.

Parameters

results

The ResultSet object that the row relates to.

data

An array containing the row data values.

number

The row number for the new row.



873
874
 
# File 'lib/src.rb', line 873

def initialize(results, data, number)
end

Instance Method Details

#[](index) ⇒ Object

This method fetches the value associated with a column within a Row object.

Parameters

index

Either the offset of the column to retrieve the value of or the alias of the column to retrieve the value of (column alias comparisons are case sensitive).



924
925
 
# File 'lib/src.rb', line 924

def [](index)
end

#aliases ⇒ Object

This method retrieves an array of column aliases for a Row object.



1030
1031
 
# File 'lib/src.rb', line 1030

def aliases
end

#column_alias(index) ⇒ Object

This method fetches the alias of a column within a row of data.

Parameters

index

The index of the column to fetch the alias for. The first column in the row is at offset zero.



911
912
 
# File 'lib/src.rb', line 911

def column_alias(index)
end

#column_count ⇒ Object

This method fetches a count of the number of columns of data that are available from a row.



889
890
 
# File 'lib/src.rb', line 889

def column_count
end

#column_name(index) ⇒ Object

This method fetches the name of a column within a row of data.

Parameters

index

The index of the column to fetch the name for. The first column in the row is at offset zero.



900
901
 
# File 'lib/src.rb', line 900

def column_name(index)
end

#each {|column, vlaue| ... } ⇒ Object

This method iterates over the contents of a Row object. The block specified for the method should accept two parameters; one for the column alias and one for the column value.

Yields:

  • (column, vlaue) 


933
934
935
 
# File 'lib/src.rb', line 933

def each
   yield column, vlaue
end

#each_key {|column| ... } ⇒ Object

This method iterates over the column names for a Row class.

Yields:

  • (column) 


941
942
943
 
# File 'lib/src.rb', line 941

def each_key
   yield column
end

#each_value {|value| ... } ⇒ Object

This method iterators over the column values for a Row class.

Yields:

  • (value) 


949
950
951
 
# File 'lib/src.rb', line 949

def each_value
   yield value
end

#fetch(key, alternative = nil) {|key| ... } ⇒ Object

An implementation of the Hash#fetch method for the Row class. The method accepts a block but this should not be specified if a value for the alternative parameter is specified.

Parameters

key

A string containing the column alias to retrieve.

alternative

A reference to the alternative value to be returned if the keyed value is not found. Defaults to nil.

Yields:

  • (key) 


964
965
966
 
# File 'lib/src.rb', line 964

def fetch(key, alternative=nil)
   yield key
end

#get_base_type(index) ⇒ Object

This method retrieves the base SQL type for a column of data within a Row object. The method returns one of the base types defined in the SQLType class but does not return an actual SQLType object.

Parameters

index

The offset from the Row first column of the column to return the type information for.



1087
1088
 
# File 'lib/src.rb', line 1087

def get_base_type(index)
end

#has_alias?(name) ⇒ Boolean

This method is used to determine whether a Row object contains a given column alias.

Parameters

name

A String containing the column alias to check for.

Returns:

  • (Boolean) 


998
999
 
# File 'lib/src.rb', line 998

def has_alias?(name)
end

#has_column?(name) ⇒ Boolean

This method is used to determine whether a Row object contains a given column name.

Parameters

name

A String containing the column name to check for.

Returns:

  • (Boolean) 


987
988
 
# File 'lib/src.rb', line 987

def has_column?(name)
end

#has_key?(name) ⇒ Boolean

This method is used to determine whether a Row object contains a given column alias.

Parameters

name

A String containing the column name to check for.

Returns:

  • (Boolean) 


976
977
 
# File 'lib/src.rb', line 976

def has_key?(name)
end

#has_value?(value) ⇒ Boolean

This method is used to determine whether a Row object contains a given column value.

Parameters

value

A reference to an object value to be checked for.

Returns:

  • (Boolean) 


1009
1010
 
# File 'lib/src.rb', line 1009

def has_value?(value)
end

#keys ⇒ Object

This method retrieves an array of column aliases for a Row object.



1016
1017
 
# File 'lib/src.rb', line 1016

def keys
end

#names ⇒ Object

This method retrieves an array of column names for a Row object.



1023
1024
 
# File 'lib/src.rb', line 1023

def names
end

#number ⇒ Object

This is the accessor for the row number attribute. This will generally reflect the order the row was fetched from the result set in, with 1 being the first row retrieved.



881
882
 
# File 'lib/src.rb', line 881

def number
end

#select {|column, value| ... } ⇒ Object

This method returns an array of the Row elements for which the specified block returns true.

Yields:

  • (column, value) 


1045
1046
1047
 
# File 'lib/src.rb', line 1045

def select
   yield column, value
end

#to_a ⇒ Object

This method retrieves an Array containing the values from a Row object. Each value is represented as an Array containing a column name and the associated column value.



1055
1056
 
# File 'lib/src.rb', line 1055

def to_a
end

#to_hash ⇒ Object

This method retrieves a Hash created from a Row objects values. The Row objects column names will be used as a key on to the column values.



1063
1064
 
# File 'lib/src.rb', line 1063

def to_hash
end

#values ⇒ Object

This method retrieves an array of column values for a Row object.



1037
1038
 
# File 'lib/src.rb', line 1037

def values
end

#values_at(*names) ⇒ Object

This method returns an array of column values based on a list of column aliases.

Parameters

names

One or more Strings containing the names of the columns to retrieve values for.



1075
1076
 
# File 'lib/src.rb', line 1075

def values_at(*names)
end