Column (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.foundations.core.Bean
- - com.northconcepts.datapipeline.foundations.pipeline.dataset.Column

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, Serializable

Direct Known Subclasses:

TreeNode
```
public class Column
extends Bean
```
Holds the metadata and statistics for each field in a dataset.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
  SERIALIZED_CLASS_NAME, TYPE
- Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
  XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Column()`
	`Column(String name, int index)`
	`Column(String name, int index, Map<Object,LongAdder> uniqueValues)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataException`	`addExceptionProperties(DataException exception)` Adds this object's current state to a `DataException`.
`Column`	`addField(Field field, Dataset dataset)`
`Column`	`addValue(Object value)`
`Column`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`Column`	`fromXmlElement(Element element)`
`long`	`getArrayValueCount()`
`long`	`getAverageLength()`
`FieldType`	`getBestFitFieldType()`
`FieldType`	`getBestFitInferredFieldType()` Returns the best fit inferred field type for the column.
`NumberDescriptor`	`getBigNumberDescriptor()` Returns NumberDescriptor with necessary details for BigInteger & BigDecimal numbers only.
`long`	`getBlankCount()`
`FieldType`	`getFieldType()`
`int`	`getFieldTypeCount()`
`Map<FieldType,LongAdder>`	`getFieldTypes()`
`int`	`getIndex()`
`long`	`getInferredBooleanValueCount()`
`FieldType`	`getInferredFieldType()` Returns the most frequently occurring type in a column.
`long`	`getInferredNumericValueCount()`
`long`	`getInferredTemporalValueCount()`
`long`	`getInferredTextualValueCount()`
`String`	`getInferredTypeName()`
`long`	`getInferredUuidValueCount()`
`long`	`getLengthSum()`
`int`	`getMaximumArrayElements()`
`int`	`getMaximumLength()`
`int`	`getMinimumArrayElements()`
`int`	`getMinimumLength()`
`String`	`getName()`
`long`	`getNonNullCount()`
`long`	`getNonNullNonBlankCount()`
`long`	`getNullCount()`
`ConcurrentSkipListMap<FieldType,LongAdder>`	`getNullValueFieldTypes()`
`NumberDescriptor`	`getNumberDescriptor()`
`String`	`getSampleValue()`
`int`	`getTemporalFieldTypeCount()`
`Map<FieldType,LongAdder>`	`getTemporalFieldTypes()`
`int`	`getTemporalPatternCount()`
`Map<DateTimePattern,LongAdder>`	`getTemporalPatterns()`
`int`	`getUniqueValueCount()`
`Map<Object,LongAdder>`	`getUniqueValues()`
`List<Map.Entry<Object,LongAdder>>`	`getUniqueValuesByCount()`
`long`	`getValueCount()`
`Column`	`incBlankCount()`
`Column`	`incNullCount()`
`boolean`	`isArray()`
`boolean`	`isBoolean()`
`static boolean`	`isBoolean(String s)`
`static boolean`	`isNumber(String string)`
`boolean`	`isNumeric()`
`boolean`	`isTemporal()`
`boolean`	`isTextual()`
`boolean`	`isUuid()`
`Column`	`setBigNumberDescriptor(NumberDescriptor bigNumberDescriptor)` Set NumberDescriptor with necessary details for BigInteger & BigDecimal numbers only.
`Column`	`setBlankCount(long blankCount)`
`Column`	`setFieldTypes(Map<FieldType,LongAdder> fieldTypes)`
`Column`	`setIndex(int index)`
`Column`	`setLengthSum(long lengthSum)`
`Column`	`setMaximumLength(int maximumLength)`
`Column`	`setMinimumLength(int minimumLength)`
`Column`	`setName(String name)`
`Column`	`setNullCount(long nullCount)`
`Column`	`setNullValueFieldTypes(ConcurrentSkipListMap<FieldType,LongAdder> nullValueFieldTypes)`
`Column`	`setNumberDescriptor(NumberDescriptor numberDescriptor)`
`Column`	`setSampleValue(String sampleValue)`
`Column`	`setTemporalFieldTypes(Map<FieldType,LongAdder> temporalFieldTypes)`
`Column`	`setTemporalPatterns(Map<DateTimePattern,LongAdder> temporalPatterns)`
`Column`	`setValueCount(long valueCount)`
`Record`	`toRecord()`
`Element`	`toXmlElement(Document document)`

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable
fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable
newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable
forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor
addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties, exception, exception, exception

Constructor Detail

Column
```
protected Column()
```

Column

public Column(String name,
              int index)

Column

public Column(String name,
              int index,
              Map<Object,LongAdder> uniqueValues)

Method Detail

getName
```
public String getName()
```

setName
```
public Column setName(String name)
```

getIndex
```
public int getIndex()
```

setIndex
```
public Column setIndex(int index)
```

getValueCount
```
public long getValueCount()
```

setValueCount

public Column setValueCount(long valueCount)

addValue
```
public Column addValue(Object value)
```

getUniqueValues

public Map<Object,LongAdder> getUniqueValues()

getUniqueValuesByCount

public List<Map.Entry<Object,LongAdder>> getUniqueValuesByCount()

getUniqueValueCount
```
public int getUniqueValueCount()
```

getNullCount
```
public long getNullCount()
```

setNullCount

public Column setNullCount(long nullCount)

incNullCount
```
public Column incNullCount()
```

getNonNullCount
```
public long getNonNullCount()
```

getNonNullNonBlankCount
```
public long getNonNullNonBlankCount()
```

getBlankCount
```
public long getBlankCount()
```

setBlankCount

public Column setBlankCount(long blankCount)

incBlankCount
```
public Column incBlankCount()
```

getInferredTextualValueCount

public long getInferredTextualValueCount()

getInferredNumericValueCount

public long getInferredNumericValueCount()

getInferredTemporalValueCount

public long getInferredTemporalValueCount()

getInferredBooleanValueCount

public long getInferredBooleanValueCount()

getInferredUuidValueCount

public long getInferredUuidValueCount()

getArrayValueCount
```
public long getArrayValueCount()
```

getMinimumArrayElements
```
public int getMinimumArrayElements()
```

getMaximumArrayElements
```
public int getMaximumArrayElements()
```

isTextual
```
public boolean isTextual()
```

isNumeric
```
public boolean isNumeric()
```

isTemporal
```
public boolean isTemporal()
```

isBoolean
```
public boolean isBoolean()
```

isUuid
```
public boolean isUuid()
```

isArray
```
public boolean isArray()
```

getInferredTypeName
```
public String getInferredTypeName()
```

getMinimumLength
```
public int getMinimumLength()
```

setMinimumLength

public Column setMinimumLength(int minimumLength)

getMaximumLength
```
public int getMaximumLength()
```

setMaximumLength

public Column setMaximumLength(int maximumLength)

getLengthSum
```
public long getLengthSum()
```

setLengthSum

public Column setLengthSum(long lengthSum)

getAverageLength
```
public long getAverageLength()
```

getFieldTypes

public Map<FieldType,LongAdder> getFieldTypes()

getInferredFieldType
```
public FieldType getInferredFieldType()
```
Returns the most frequently occurring type in a column.
For example, if a column contains 10 integer values and 9 boolean values, the inferred field type for that column will be FieldType.INT.

getBestFitInferredFieldType
```
public FieldType getBestFitInferredFieldType()
```
Returns the best fit inferred field type for the column.
If there is more than one inferred type, it will return the best fit field type based on the getBestFitFieldType() method.

setFieldTypes

public Column setFieldTypes(Map<FieldType,LongAdder> fieldTypes)

addField

public Column addField(Field field,
                       Dataset dataset)

getFieldTypeCount
```
public int getFieldTypeCount()
```

getFieldType
```
public FieldType getFieldType()
```

getNullValueFieldTypes

public ConcurrentSkipListMap<FieldType,LongAdder> getNullValueFieldTypes()

setNullValueFieldTypes

public Column setNullValueFieldTypes(ConcurrentSkipListMap<FieldType,LongAdder> nullValueFieldTypes)

getBestFitFieldType

public FieldType getBestFitFieldType()

getTemporalPatterns

public Map<DateTimePattern,LongAdder> getTemporalPatterns()

setTemporalPatterns

public Column setTemporalPatterns(Map<DateTimePattern,LongAdder> temporalPatterns)

getTemporalPatternCount
```
public int getTemporalPatternCount()
```

getTemporalFieldTypes

public Map<FieldType,LongAdder> getTemporalFieldTypes()

setTemporalFieldTypes

public Column setTemporalFieldTypes(Map<FieldType,LongAdder> temporalFieldTypes)

getTemporalFieldTypeCount

public int getTemporalFieldTypeCount()

getNumberDescriptor

public NumberDescriptor getNumberDescriptor()

setNumberDescriptor

public Column setNumberDescriptor(NumberDescriptor numberDescriptor)

getBigNumberDescriptor
```
public NumberDescriptor getBigNumberDescriptor()
```
Returns NumberDescriptor with necessary details for BigInteger & BigDecimal numbers only.

setBigNumberDescriptor
```
public Column setBigNumberDescriptor(NumberDescriptor bigNumberDescriptor)
```
Set NumberDescriptor with necessary details for BigInteger & BigDecimal numbers only.

getSampleValue
```
public String getSampleValue()
```

setSampleValue

public Column setSampleValue(String sampleValue)

isNumber

public static boolean isNumber(String string)

isBoolean

public static boolean isBoolean(String s)

toRecord
```
public Record toRecord()
```
Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord
```
public Column fromRecord(Record source)
```
Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class Bean

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

fromXmlElement

public Column fromXmlElement(Element element)

addExceptionProperties
```
public DataException addExceptionProperties(DataException exception)
```
Description copied from interface: DataExceptionContributor

Adds this object's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Specified by:

addExceptionProperties in interface DataExceptionContributor

Overrides:

addExceptionProperties in class Bean

Class Column

Field Summary

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

Methods inherited from class java.lang.Object

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

Constructor Detail

Column

Column

Column

Method Detail

getName

setName

getIndex

setIndex

getValueCount

setValueCount

addValue

getUniqueValues

getUniqueValuesByCount

getUniqueValueCount

getNullCount

setNullCount

incNullCount

getNonNullCount

getNonNullNonBlankCount

getBlankCount

setBlankCount

incBlankCount

getInferredTextualValueCount

getInferredNumericValueCount

getInferredTemporalValueCount

getInferredBooleanValueCount

getInferredUuidValueCount

getArrayValueCount

getMinimumArrayElements

getMaximumArrayElements

isTextual

isNumeric

isTemporal

isBoolean

isUuid

isArray

getInferredTypeName

getMinimumLength

setMinimumLength

getMaximumLength

setMaximumLength

getLengthSum

setLengthSum

getAverageLength

getFieldTypes

getInferredFieldType

getBestFitInferredFieldType

setFieldTypes

addField

getFieldTypeCount

getFieldType

getNullValueFieldTypes

setNullValueFieldTypes

getBestFitFieldType

getTemporalPatterns

setTemporalPatterns

getTemporalPatternCount

getTemporalFieldTypes

setTemporalFieldTypes

getTemporalFieldTypeCount

getNumberDescriptor

setNumberDescriptor

getBigNumberDescriptor

setBigNumberDescriptor

getSampleValue

setSampleValue

isNumber