1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# WindowSpec.R - WindowSpec class and methods implemented in S4 OO classes
#' @include generics.R jobj.R column.R
NULL
#' S4 class that represents a WindowSpec
#'
#' WindowSpec can be created by using windowPartitionBy() or windowOrderBy()
#'
#' @rdname WindowSpec
#' @seealso \link{windowPartitionBy}, \link{windowOrderBy}
#'
#' @param sws A Java object reference to the backing Scala WindowSpec
#' @export
#' @note WindowSpec since 2.0.0
setClass("WindowSpec",
slots = list(sws = "jobj"))
setMethod("initialize", "WindowSpec", function(.Object, sws) {
.Object@sws <- sws
.Object
})
windowSpec <- function(sws) {
stopifnot(class(sws) == "jobj")
new("WindowSpec", sws)
}
#' @rdname show
#' @note show(WindowSpec) since 2.0.0
setMethod("show", "WindowSpec",
function(object) {
cat("WindowSpec", callJMethod(object@sws, "toString"), "\n")
})
#' partitionBy
#'
#' Defines the partitioning columns in a WindowSpec.
#'
#' @param x a WindowSpec
#' @return a WindowSpec
#' @rdname partitionBy
#' @name partitionBy
#' @aliases partitionBy,WindowSpec-method
#' @family windowspec_method
#' @export
#' @examples
#' \dontrun{
#' partitionBy(ws, "col1", "col2")
#' partitionBy(ws, df$col1, df$col2)
#' }
#' @note partitionBy(WindowSpec) since 2.0.0
setMethod("partitionBy",
signature(x = "WindowSpec"),
function(x, col, ...) {
stopifnot (class(col) %in% c("character", "Column"))
if (class(col) == "character") {
windowSpec(callJMethod(x@sws, "partitionBy", col, list(...)))
} else {
jcols <- lapply(list(col, ...), function(c) {
c@jc
})
windowSpec(callJMethod(x@sws, "partitionBy", jcols))
}
})
#' orderBy
#'
#' Defines the ordering columns in a WindowSpec.
#'
#' @param x a WindowSpec
#' @return a WindowSpec
#' @rdname arrange
#' @name orderBy
#' @aliases orderBy,WindowSpec,character-method
#' @family windowspec_method
#' @export
#' @examples
#' \dontrun{
#' orderBy(ws, "col1", "col2")
#' orderBy(ws, df$col1, df$col2)
#' }
#' @note orderBy(WindowSpec, character) since 2.0.0
setMethod("orderBy",
signature(x = "WindowSpec", col = "character"),
function(x, col, ...) {
windowSpec(callJMethod(x@sws, "orderBy", col, list(...)))
})
#' @rdname arrange
#' @name orderBy
#' @aliases orderBy,WindowSpec,Column-method
#' @export
#' @note orderBy(WindowSpec, Column) since 2.0.0
setMethod("orderBy",
signature(x = "WindowSpec", col = "Column"),
function(x, col, ...) {
jcols <- lapply(list(col, ...), function(c) {
c@jc
})
windowSpec(callJMethod(x@sws, "orderBy", jcols))
})
#' rowsBetween
#'
#' Defines the frame boundaries, from `start` (inclusive) to `end` (inclusive).
#'
#' Both `start` and `end` are relative positions from the current row. For example, "0" means
#' "current row", while "-1" means the row before the current row, and "5" means the fifth row
#' after the current row.
#'
#' @param x a WindowSpec
#' @param start boundary start, inclusive.
#' The frame is unbounded if this is the minimum long value.
#' @param end boundary end, inclusive.
#' The frame is unbounded if this is the maximum long value.
#' @return a WindowSpec
#' @rdname rowsBetween
#' @aliases rowsBetween,WindowSpec,numeric,numeric-method
#' @name rowsBetween
#' @family windowspec_method
#' @export
#' @examples
#' \dontrun{
#' rowsBetween(ws, 0, 3)
#' }
#' @note rowsBetween since 2.0.0
setMethod("rowsBetween",
signature(x = "WindowSpec", start = "numeric", end = "numeric"),
function(x, start, end) {
# "start" and "end" should be long, due to serde limitation,
# limit "start" and "end" as integer now
windowSpec(callJMethod(x@sws, "rowsBetween", as.integer(start), as.integer(end)))
})
#' rangeBetween
#'
#' Defines the frame boundaries, from `start` (inclusive) to `end` (inclusive).
#'
#' Both `start` and `end` are relative from the current row. For example, "0" means "current row",
#' while "-1" means one off before the current row, and "5" means the five off after the
#' current row.
#' @param x a WindowSpec
#' @param start boundary start, inclusive.
#' The frame is unbounded if this is the minimum long value.
#' @param end boundary end, inclusive.
#' The frame is unbounded if this is the maximum long value.
#' @return a WindowSpec
#' @rdname rangeBetween
#' @aliases rangeBetween,WindowSpec,numeric,numeric-method
#' @name rangeBetween
#' @family windowspec_method
#' @export
#' @examples
#' \dontrun{
#' rangeBetween(ws, 0, 3)
#' }
#' @note rangeBetween since 2.0.0
setMethod("rangeBetween",
signature(x = "WindowSpec", start = "numeric", end = "numeric"),
function(x, start, end) {
# "start" and "end" should be long, due to serde limitation,
# limit "start" and "end" as integer now
windowSpec(callJMethod(x@sws, "rangeBetween", as.integer(start), as.integer(end)))
})
# Note that over is a method of Column class, but it is placed here to
# avoid Roxygen circular-dependency between class Column and WindowSpec.
#' over
#'
#' Define a windowing column.
#'
#' @rdname over
#' @name over
#' @aliases over,Column,WindowSpec-method
#' @family colum_func
#' @export
#' @note over since 2.0.0
setMethod("over",
signature(x = "Column", window = "WindowSpec"),
function(x, window) {
column(callJMethod(x@jc, "over", window@sws))
})
|
