GeoMesaParam

Instance Constructors

new GeoMesaParam(_key: String, desc: String = "", optional: Boolean = true, default: T = null, password: Boolean = false, largeText: Boolean = false, extension: String = null, deprecatedKeys: Seq[String] = Seq.empty, deprecatedParams: Seq[DeprecatedParam[T]] = Seq.empty, systemProperty: Option[SystemPropertyParam[T]] = None, enumerations: Seq[T] = Seq.empty, supportsNiFiExpressions: Boolean = false)(implicit ct: ClassTag[T])

_key
key used to look up values
desc
readable description of the parameter
optional
optional, or required
default
default value, if any
password
is the parameter a password
largeText
should the parameter use a text area instead of a text box in a GUI
extension
filter for file upload extensions
deprecatedKeys
deprecated keys for this parameter
deprecatedParams
deprecated params replaced by this parameter, but that require conversion
systemProperty
system property used as a fallback lookup
enumerations
list of values used to restrain the user input

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val default: T

default value, if any
val deprecatedKeys: Seq[String]

deprecated keys for this parameter
val deprecatedParams: Seq[DeprecatedParam[T]]

deprecated params replaced by this parameter, but that require conversion
def deprecationWarning(deprecated: String): Unit

Logs a warning about deprecated parameter keys
Logs a warning about deprecated parameter keys
deprecated
deprecated key found
val enumerations: Seq[T]

list of values used to restrain the user input
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
Parameter → AnyRef → Any
def exists(params: Map[String, _]): Boolean

Checks that the parameter is contained in the map, but does not do type conversion
Checks that the parameter is contained in the map, but does not do type conversion
params
parameter map
val extension: String

filter for file upload extensions
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getDefaultValue(): T

Definition Classes
Parameter → Parameter
def getDescription(): InternationalString

Definition Classes
Parameter → Parameter
def getLevel(): String

Definition Classes
Parameter
def getMaxOccurs(): Int

Definition Classes
Parameter → Parameter
def getMinOccurs(): Int

Definition Classes
Parameter → Parameter
def getName(): String

Definition Classes
Parameter → Parameter
def getTitle(): InternationalString

Definition Classes
Parameter → Parameter
def getType(): Class[T]

Definition Classes
Parameter → Parameter
def handle(arg0: String): AnyRef

Definition Classes
Param
Annotations
@throws( classOf[java.io.IOException] )
def hashCode(): Int

Definition Classes
Parameter → AnyRef → Any
def isDeprecated(): Boolean

Definition Classes
Parameter
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPassword(): Boolean

Definition Classes
Parameter
def isRequired(): Boolean

Definition Classes
Parameter → Parameter
val largeText: Boolean

should the parameter use a text area instead of a text box in a GUI
lazy val logger: Logger

Attributes
protected
Definition Classes
LazyLogging
def lookUp(arg0: Map[String, _]): AnyRef

Definition Classes
Param
Annotations
@throws( classOf[java.io.IOException] )
def lookup(params: Map[String, _]): T

Returns the typed value from the map.
Returns the typed value from the map. Priority is:
1. primary key from the map 2. deprecated keys from the map 3. system property, if defined 4. default value, if defined 5. null
Required parameters must be contained in the map, they will not fall back to default values or system properties
params
parameter map
def lookupOpt(params: Map[String, _]): Option[T]

Lookup for optional parameters.
Lookup for optional parameters. If a default or system property is defined, will be returned
params
parameter map
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parse(arg0: String): AnyRef

Definition Classes
Param
Annotations
@throws( classOf[java.lang.Throwable] )
val password: Boolean

is the parameter a password
val supportsNiFiExpressions: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val systemProperty: Option[SystemPropertyParam[T]]

system property used as a fallback lookup
def text(value: AnyRef): String

Definition Classes
GeoMesaParam → Param
def toString(): String

Definition Classes
Param → Parameter → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object GeoMesaParam | package geotools

class GeoMesaParam[T <: AnyRef] extends Param with LazyLogging

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val default: T

val deprecatedKeys: Seq[String]

val deprecatedParams: Seq[DeprecatedParam[T]]

def deprecationWarning(deprecated: String): Unit

val enumerations: Seq[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exists(params: Map[String, _]): Boolean

val extension: String

def finalize(): Unit

final def getClass(): Class[_]

def getDefaultValue(): T

def getDescription(): InternationalString

def getLevel(): String

def getMaxOccurs(): Int

def getMinOccurs(): Int

def getName(): String

def getTitle(): InternationalString

def getType(): Class[T]

def handle(arg0: String): AnyRef

def hashCode(): Int

def isDeprecated(): Boolean

final def isInstanceOf[T0]: Boolean

def isPassword(): Boolean

def isRequired(): Boolean

val largeText: Boolean

lazy val logger: Logger

def lookUp(arg0: Map[String, _]): AnyRef

def lookup(params: Map[String, _]): T

def lookupOpt(params: Map[String, _]): Option[T]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(arg0: String): AnyRef

val password: Boolean

val supportsNiFiExpressions: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

val systemProperty: Option[SystemPropertyParam[T]]

def text(value: AnyRef): String

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from LazyLogging

Inherited from Param

Inherited from Parameter[T]

Inherited from Parameter[T]

Inherited from AnyRef

Inherited from Any

Ungrouped