-
Notifications
You must be signed in to change notification settings - Fork 80
/
Parameters.scala
98 lines (88 loc) · 3 KB
/
Parameters.scala
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
/*
* Copyright 2018 ABSA Group Limited
*
* Licensed 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.
*/
package za.co.absa.cobrix.spark.cobol.parameters
import scala.collection.mutable
/**
* Wraps parameters provided by spark.read.option(...) in order to track which parameters are
* actually used/recognized.
*
* @param params Parameters provided by spark.read.option(...)
*/
class Parameters(params: Map[String, String]) {
private val usedKeys = new mutable.HashSet[String]
/**
* Gets a value from the underlying parameters map tracking its usage.
*
* @param key A key to the parameters map
* @return A value associated with the key
*/
def apply(key: String): String = {
usedKeys += key
params(key)
}
/**
* Gets a value from the underlying parameters map tracking its usage.
*
* @param key A key to the parameters map
* @return An option boxed value associated with the key
*/
def get(key: String): Option[String] = {
usedKeys += key
params.get(key)
}
/**
* Marks that a key is actually used by 'spark-cobol'. The method is used when options are
* processed by enumerating the underlying map.
*
* @param key A key to the parameters map
*/
def markUsed(key: String): Unit = usedKeys += key
/**
* Returns true if a key is present in the underlying map tracking its usage.
*
* @param key A key to the parameters map
* @return True if the key is present in the map
*/
def contains(key: String): Boolean = {
usedKeys += key
params.contains(key)
}
/**
* Gets a value from the underlying parameters map tracking its usage.
*
* @param key A key to the parameters map
* @param default A default value that will be returned if the map does not contain the key.
* @return An value associated with the key or the default value if the key is not present in the map
*/
def getOrElse(key: String, default: => String): String = {
usedKeys += key
params.getOrElse(key, default)
}
/**
* Returns the underlying map. This is used for getting spark-cobol options by enumerating the map itself.
*
* @return The underlying parameters map
*/
def getMap: Map[String, String] = params
/**
* Returns the underlying map. This is used for getting spark-cobol options by enumerating the map itself.
*
* @return True is the provided key was used for determining how a COBOL data need to be processed.
*/
def isKeyUsed(key: String): Boolean = {
usedKeys.contains(key)
}
}