pan-data/pd.exception/Requirement

Requirement

class Requirement(df: DataFrame, _all: Boolean, _strict: Boolean)
class Object
trait Matchable
class Any

Value members

Concrete methods

def all: Requirement

If called, subsequent methods (by default) require that all values are defined.

If called, subsequent methods (by default) require that all values are defined.

Returns

Requirement.

Since

0.1.0

def check[T](col: String, condition: T => Boolean, all: Boolean)(implicit evidence$1: ClassTag[T], evidence$2: Typeable[T], evidence$3: RequireType[T]): Requirement

Raises an exception if the column does not fulfill the check.

Raises an exception if the column does not fulfill the check.

Value Params
all

If true, all values of the column must be defined.

col

Column to be checked.

condition

Predicate function to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def checkAll[T](col: String, condition: T => Boolean)(implicit evidence$4: ClassTag[T], evidence$5: Typeable[T], evidence$6: RequireType[T]): Requirement

Raises an exception if the column does not fulfill the check or values are undefined.

Raises an exception if the column does not fulfill the check or values are undefined.

Value Params
col

Column name.

condition

Predicate function to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def equals(df: DataFrame): Requirement

Raises an exception if the DataFrame does not match the expected DataFrame.

Raises an exception if the DataFrame does not match the expected DataFrame.

Value Params
df

Expected DataFrame.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def equalsCol[T](col: String, series: Series[T])(implicit evidence$7: ClassTag[T]): Requirement

Raises an exception if column is missing or values do not match.

Raises an exception if column is missing or values do not match.

Value Params
col

Column to be checked.

series

Required values. If the Series has a name, it is ignored.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def equalsCol[T](series: Series[T])(implicit evidence$8: ClassTag[T]): Requirement

Raises an exception if column is missing or values do not match.

Raises an exception if column is missing or values do not match.

Value Params
series

Expected column where the column name is the name of the Series .

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def equalsCol[T](col: String)(values: T | Null*)(implicit evidence$9: ClassTag[T]): Requirement

Raises an exception if column is missing or values do not match.

Raises an exception if column is missing or values do not match.

Value Params
col

Column to be checked.

values

Required values.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def has(cols: String*): Requirement

Raises an exception if one of the column names is missing.

Raises an exception if one of the column names is missing.

Value Params
cols

Columns names that are required.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def hasExactly(cols: String*): Requirement

Raises an exception if column names are not matching the given list, i.e. missing or additional columns names with arbitrary order.

Raises an exception if column names are not matching the given list, i.e. missing or additional columns names with arbitrary order.

Value Params
cols

Columns names that are required.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def hasNumCols(n: Int): Requirement

Raises an exception if the number of columns does not match.

Raises an exception if the number of columns does not match.

Value Params
n

Expected number of columns

Returns

Requirement.

Since

0.1.0

def hasNumRows(n: Int): Requirement

Raises an exception if the number of rows does not match.

Raises an exception if the number of rows does not match.

Value Params
n

Expected number of rows

Returns

Requirement.

Since

0.1.0

def isType[T](col: String, all: Boolean)(implicit evidence$10: Typeable[T], evidence$11: RequireType[T]): Requirement

Raises an exception if the column is not of type T.

Raises an exception if the column is not of type T.

Type Params
T

Required type.

Value Params
all

If true, raises also an exception if values are undefined.

col

Column to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def isType[T](cols: String*)(implicit evidence$12: Typeable[T], evidence$13: RequireType[T]): Requirement

Raises an exception if the columns are not of type T.

Raises an exception if the columns are not of type T.

Type Params
T

Required type.

Value Params
cols

Columns to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def isTypeAll[T](cols: String*)(implicit evidence$14: Typeable[T], evidence$15: RequireType[T]): Requirement

Raises an exception if the columns are not of type T or have undefined values.

Raises an exception if the columns are not of type T or have undefined values.

Type Params
T

Required type.

Value Params
cols

Columns to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def isTypeAllStrictly[T](cols: String*)(implicit evidence$16: Typeable[T], evidence$17: RequireType[T]): Requirement

Raises an exception if the columns are not of type T or have undefined values. The type check is performed on all values which may cause a slower performance.

Raises an exception if the columns are not of type T or have undefined values. The type check is performed on all values which may cause a slower performance.

Type Params
T

Required type.

Value Params
cols

Columns to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def isTypeStrictly[T](col: String, all: Boolean)(implicit evidence$18: Typeable[T], evidence$19: RequireType[T]): Requirement

Raises an exception if the columns are not of type T. The type check is performed on all values which may cause a slower performance.

Raises an exception if the columns are not of type T. The type check is performed on all values which may cause a slower performance.

Type Params
T

Required type.

Value Params
all

If true, raises also an exception if values are undefined.

col

Column to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def isTypeStrictly[T](cols: String*)(implicit evidence$20: Typeable[T], evidence$21: RequireType[T]): Requirement

Raises an exception if the columns are not of type T. The type check is performed on all values which may cause a slower performance.

Raises an exception if the columns are not of type T. The type check is performed on all values which may cause a slower performance.

Type Params
T

Required type.

Value Params
cols

Columns to be checked.

Returns

Requirement.

Throws
RequirementException

If the requirement fails.

Since

0.1.0

def strictly: Requirement

If called, subsequent methods (by default) perform type checks on all values which may cause a slower performance.

If called, subsequent methods (by default) perform type checks on all values which may cause a slower performance.

Returns

Requirement.

Since

0.1.0