Class: Mongoose::BaseColumn

Inherits:
Object show all
Defined in:
lib/mongoose/column.rb

Overview

BaseColumn class

Direct Known Subclasses

Column, IndexedColumn

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tbl_class, name, col_def) ⇒ BaseColumn

Returns a new instance of BaseColumn.



22
23
24
25
26
27
28
 
# File 'lib/mongoose/column.rb', line 22

def initialize(tbl_class, name, col_def)
  @tbl_class = tbl_class
  @name = name
  @data_type = col_def
  @indexed = false
  @required = false
end

Instance Attribute Details

#data_type ⇒ Object (readonly)

Returns the value of attribute data_type.



9
10
11
 
# File 'lib/mongoose/column.rb', line 9

def data_type
  @data_type
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



9
10
11
 
# File 'lib/mongoose/column.rb', line 9

def name
  @name
end

#required=(value) ⇒ Object (writeonly)

Sets the attribute required

Parameters:

  • value —

    the value to set the attribute required to.



10
11
12
 
# File 'lib/mongoose/column.rb', line 10

def required=(value)
  @required = value
end

#tbl_class ⇒ Object (readonly)

Returns the value of attribute tbl_class.



9
10
11
 
# File 'lib/mongoose/column.rb', line 9

def tbl_class
  @tbl_class
end

Class Method Details

.create(tbl_class, name, col_def) ⇒ Object 



18
19
20
 
# File 'lib/mongoose/column.rb', line 18

def self.create(tbl_class, name, col_def)
  return new(tbl_class, name, col_def)
end

.valid_data_type?(data_type) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/mongoose/column.rb', line 14

def self.valid_data_type?(data_type)
  DATA_TYPES.include?(data_type)
end

Instance Method Details

#close ⇒ Object 



38
39
 
# File 'lib/mongoose/column.rb', line 38

def close
end

#indexed? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/mongoose/column.rb', line 30

def indexed?
  @indexed
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/mongoose/column.rb', line 34

def required?
  @required
end