Class: Arel::Nodes::Window

Inherits:
Node
  • Object
show all
Includes:
Expression
Defined in:
lib/arel/nodes/window.rb

Direct Known Subclasses

NamedWindow

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OrderPredications

#asc, #desc

Methods inherited from Node

#and, #each, #not, #or, #to_sql

Methods included from FactoryMethods

#create_and, #create_false, #create_join, #create_on, #create_string_join, #create_table_alias, #create_true, #grouping, #lower

Constructor Details

#initializeWindow

Returns a new instance of Window.



7
8
9
# File 'lib/arel/nodes/window.rb', line 7

def initialize
  @orders = []
end

Instance Attribute Details

#framingObject

Returns the value of attribute framing.



5
6
7
# File 'lib/arel/nodes/window.rb', line 5

def framing
  @framing
end

#ordersObject

Returns the value of attribute orders.



5
6
7
# File 'lib/arel/nodes/window.rb', line 5

def orders
  @orders
end

Instance Method Details

#frame(expr) ⇒ Object

Raises:

  • (ArgumentError)


19
20
21
22
# File 'lib/arel/nodes/window.rb', line 19

def frame(expr)
  raise ArgumentError, "Window frame cannot be set more than once" if @frame
  @framing = expr
end

#initialize_copy(other) ⇒ Object



32
33
34
35
# File 'lib/arel/nodes/window.rb', line 32

def initialize_copy other
  super
  @orders = @orders.map { |x| x.clone }
end

#order(*expr) ⇒ Object



11
12
13
14
15
16
17
# File 'lib/arel/nodes/window.rb', line 11

def order *expr
  # FIXME: We SHOULD NOT be converting these to SqlLiteral automatically
  @orders.concat expr.map { |x|
    String === x || Symbol === x ? Nodes::SqlLiteral.new(x.to_s) : x
  }
  self
end

#range(expr = nil) ⇒ Object



28
29
30
# File 'lib/arel/nodes/window.rb', line 28

def range(expr = nil)
  frame(Range.new(expr))
end

#rows(expr = nil) ⇒ Object



24
25
26
# File 'lib/arel/nodes/window.rb', line 24

def rows(expr = nil)
  frame(Rows.new(expr))
end