Package com.seeq.model
Class DatafileInputV1
java.lang.Object
com.seeq.model.DatafileInputV1
DatafileInputV1
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The character used as the CSV field delimiter.static enum
The type of item to be imported from the CSV file.static enum
The format of the sample timestamps for signals or the format of the capsule start and end times for a condition.static enum
The approach to use when CSV data cannot be parsed. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalPropertiesItem
(ScalarPropertyV1 additionalPropertiesItem) additionalProperties
(List<ScalarPropertyV1> additionalProperties) addPropertiesItem
(ScalarPropertyV1 propertiesItem) conditionName
(String conditionName) dayFirstDefault
(Boolean dayFirstDefault) description
(String description) descriptionRow
(Integer descriptionRow) endColumnIndex
(Integer endColumnIndex) endColumnName
(String endColumnName) boolean
fieldDelimiter
(DatafileInputV1.FieldDelimiterEnum fieldDelimiter) firstDataRow
(Integer firstDataRow) Get additionalPropertiesIf true, append the data in this CSV file to the signals or condition.The name to use for the condition being imported.The data ID of this item.If true, assume day first dates when ambiguous.Clarifying information or other plain language description of this item.Integer that identifies the row containing the description for each signal.Integer that identifies the column containing the capsule end key for the condition.The name of the column containing the capsule end key for the condition.The character used as the CSV field delimiter.The name of the file that the client uploaded.Integer that identifies the row at which to start reading the data.The ID of the datasource hosting this item.The interpolation method used to represent the values between samples in the signal.Integer that identifies the row containing the interpolation method for each signal.The type of item to be imported from the CSV file.Integer that identifies the column containing the sample timestamps for the signal(s) or the column containing the capsule start key for the condition.The name of the column containing the signal timestamps for the signal(s) or the column containing the capsule start key for the condition.The format of the sample timestamps for signals or the format of the capsule start and end times for a condition.If true, hours are allowed that don't exist due to the spring forward daylight savings transition.The maximum duration of the capsules in the condition.The maximum spacing between adjacent sample keys that can be interpolated across.Integer that identifies the row containing the maximum interpolation for each signal.getName()
Human readable name.Prefix prepended to the name of each signal when importing signal(s) and prepended to the name of each capsule property when importing a condition.Integer that identifies the header row used to name the signal(s) when importing signal(s) and used to name the capsule properties when importing a condition.Suffix appended to the name of each signal when importing signal(s) and appended to the name of each capsule property when importing a condition.Get propertiesThe ID of the workbook to which this item will be scoped.If the timestamps (key for signals, start/end for a condition) contain no time zone information, they will be interpreted as being in this time zone.The server-side name of the CSV file that is returned from the upload endpoint.The approach to use when CSV data cannot be parsed.List of integers identifying the columns to import.List of comma separated case sensitive names of the columns to import.The unit of measure to be used for every signal when importing signals and for every capsule property when importing a condition.Integer that identifies the row containing the unit of measure for each signal when importing signal(s) or for each capsule property when importing a condition.int
hashCode()
interpolationMethod
(String interpolationMethod) interpolationMethodRow
(Integer interpolationMethodRow) itemType
(DatafileInputV1.ItemTypeEnum itemType) keyColumnIndex
(Integer keyColumnIndex) keyColumnName
(String keyColumnName) keyFormat
(DatafileInputV1.KeyFormatEnum keyFormat) lenientDaylightSavings
(Boolean lenientDaylightSavings) maximumDuration
(String maximumDuration) maximumInterpolation
(String maximumInterpolation) maximumInterpolationRow
(Integer maximumInterpolationRow) namePrefix
(String namePrefix) nameSuffix
(String nameSuffix) properties
(List<ScalarPropertyV1> properties) void
setAdditionalProperties
(List<ScalarPropertyV1> additionalProperties) void
void
setConditionName
(String conditionName) void
void
setDayFirstDefault
(Boolean dayFirstDefault) void
setDescription
(String description) void
setDescriptionRow
(Integer descriptionRow) void
setEndColumnIndex
(Integer endColumnIndex) void
setEndColumnName
(String endColumnName) void
setFieldDelimiter
(DatafileInputV1.FieldDelimiterEnum fieldDelimiter) void
setFilename
(String filename) void
setFirstDataRow
(Integer firstDataRow) void
void
setInterpolationMethod
(String interpolationMethod) void
setInterpolationMethodRow
(Integer interpolationMethodRow) void
setItemType
(DatafileInputV1.ItemTypeEnum itemType) void
setKeyColumnIndex
(Integer keyColumnIndex) void
setKeyColumnName
(String keyColumnName) void
setKeyFormat
(DatafileInputV1.KeyFormatEnum keyFormat) void
setLenientDaylightSavings
(Boolean lenientDaylightSavings) void
setMaximumDuration
(String maximumDuration) void
setMaximumInterpolation
(String maximumInterpolation) void
setMaximumInterpolationRow
(Integer maximumInterpolationRow) void
void
setNamePrefix
(String namePrefix) void
setNameRow
(Integer nameRow) void
setNameSuffix
(String nameSuffix) void
setProperties
(List<ScalarPropertyV1> properties) void
setScopedTo
(String scopedTo) void
setTimeZone
(String timeZone) void
setUploadFilename
(String uploadFilename) void
setValidationMode
(DatafileInputV1.ValidationModeEnum validationMode) void
setValueColumnIndices
(String valueColumnIndices) void
setValueColumnNames
(String valueColumnNames) void
setValueUom
(String valueUom) void
setValueUomRow
(Integer valueUomRow) toString()
uploadFilename
(String uploadFilename) validationMode
(DatafileInputV1.ValidationModeEnum validationMode) valueColumnIndices
(String valueColumnIndices) valueColumnNames
(String valueColumnNames) valueUomRow
(Integer valueUomRow)
-
Constructor Details
-
DatafileInputV1
public DatafileInputV1()
-
-
Method Details
-
additionalProperties
-
addAdditionalPropertiesItem
-
getAdditionalProperties
Get additionalProperties- Returns:
- additionalProperties
-
setAdditionalProperties
-
append
-
getAppend
If true, append the data in this CSV file to the signals or condition.- Returns:
- append
-
setAppend
-
conditionName
-
getConditionName
The name to use for the condition being imported. If this datafile already has a condition by this name, the import will modify the already existing condition rather than creating another condition with the same name. This setting is ignored when importing signals.- Returns:
- conditionName
-
setConditionName
-
dataId
-
getDataId
The data ID of this item. Note: This is not the Seeq ID, but the unique identifier that the remote datasource uses.- Returns:
- dataId
-
setDataId
-
dayFirstDefault
-
getDayFirstDefault
If true, assume day first dates when ambiguous. If false (default), assume month first dates when ambiguous. For example, 07/01/16 is ambiguous and could be a day first or month first date. This setting is only used when there is not enough information in the column to distinguish month first from day first dates.- Returns:
- dayFirstDefault
-
setDayFirstDefault
-
description
-
getDescription
Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.- Returns:
- description
-
setDescription
-
descriptionRow
-
getDescriptionRow
Integer that identifies the row containing the description for each signal. If there is no such row, set to 0. If not specified, defaults to 0. (Row 1 is the first row of the file.) If importing a condition, the content of this row is ignored.- Returns:
- descriptionRow
-
setDescriptionRow
-
endColumnIndex
-
getEndColumnIndex
Integer that identifies the column containing the capsule end key for the condition. If not specified, defaults to keyColumnIndex + 1. If endColumnName is specified, this setting will be ignored. If importing a signal, this setting is ignored.- Returns:
- endColumnIndex
-
setEndColumnIndex
-
endColumnName
-
getEndColumnName
The name of the column containing the capsule end key for the condition. If not specified or whitespace, the endColumnIndex will be used. If specified, the endColumnIndex will be ignored.- Returns:
- endColumnName
-
setEndColumnName
-
fieldDelimiter
-
getFieldDelimiter
The character used as the CSV field delimiter. The possibilities are comma, semicolon, and tab. If not specified, defaults to comma.- Returns:
- fieldDelimiter
-
setFieldDelimiter
-
filename
-
getFilename
The name of the file that the client uploaded. Useful for keeping track of what file was used to create the Datafile.- Returns:
- filename
-
setFilename
-
firstDataRow
-
getFirstDataRow
Integer that identifies the row at which to start reading the data. If not specified, defaults to 2. (Row 1 is the first row of the file.)- Returns:
- firstDataRow
-
setFirstDataRow
-
hostId
-
getHostId
The ID of the datasource hosting this item. Note that this is a Seeq-generated ID, not the way that the datasource identifies itself.- Returns:
- hostId
-
setHostId
-
interpolationMethod
-
getInterpolationMethod
The interpolation method used to represent the values between samples in the signal. The possibilities are: Linear, PILinear, and Step. If not specified, defaults to Linear. If an interpolation method row is specified, the information in that row overrides this setting. If importing a condition, this setting is ignored.- Returns:
- interpolationMethod
-
setInterpolationMethod
-
interpolationMethodRow
-
getInterpolationMethodRow
Integer that identifies the row containing the interpolation method for each signal. If there is no such row, set to 0. If not specified, defaults to 0. If an interpolation method in the row is not recognized, the import will fail. If an interpolation method in the row is blank, the interpolationMethod setting will be used as the default. (Row 1 is the first row of the file.)If importing a condition, the content of this row is ignored.- Returns:
- interpolationMethodRow
-
setInterpolationMethodRow
-
itemType
-
getItemType
The type of item to be imported from the CSV file. Supported types include signal and condition.- Returns:
- itemType
-
setItemType
-
keyColumnIndex
-
getKeyColumnIndex
Integer that identifies the column containing the sample timestamps for the signal(s) or the column containing the capsule start key for the condition. If not specified, defaults to 1, the first column. If keyColumnName is specified, this setting will be ignored.- Returns:
- keyColumnIndex
-
setKeyColumnIndex
-
keyColumnName
-
getKeyColumnName
The name of the column containing the signal timestamps for the signal(s) or the column containing the capsule start key for the condition. If not specified or whitespace, the keyColumnIndex will be used. If specified, the keyColumnIndex will be ignored.- Returns:
- keyColumnName
-
setKeyColumnName
-
keyFormat
-
getKeyFormat
The format of the sample timestamps for signals or the format of the capsule start and end times for a condition. If not specified, defaults to ISO8601.- Returns:
- keyFormat
-
setKeyFormat
-
lenientDaylightSavings
-
getLenientDaylightSavings
If true, hours are allowed that don't exist due to the spring forward daylight savings transition. They are interpreted as occurring in the following hour. The true setting should not be needed if the data was logged appropriately for its time zone. If false (default), data in hours that don't exist will cause the import to fail.- Returns:
- lenientDaylightSavings
-
setLenientDaylightSavings
-
maximumDuration
-
getMaximumDuration
The maximum duration of the capsules in the condition. Capsules greater than this duration will be imported but will not returned when data from the condition is requested. If importing a signal, this setting is ignored.- Returns:
- maximumDuration
-
setMaximumDuration
-
maximumInterpolation
-
getMaximumInterpolation
The maximum spacing between adjacent sample keys that can be interpolated across. If two samples are spaced by more than maximum interpolation, there will be a hole in the signal between them. If not specified, defaults to 40h. If a maximum interpolation row is specified, the information in that row overrides this setting. If importing a condition, this setting is ignored.- Returns:
- maximumInterpolation
-
setMaximumInterpolation
-
maximumInterpolationRow
-
getMaximumInterpolationRow
Integer that identifies the row containing the maximum interpolation for each signal. If there is no such row, set to 0. If not specified, defaults to 0. If a maximum duration in the row is not recognized, the import will fail. If an maximum interpolation in the row is blank, the maximumInterpolation setting will be used as the default. (Row 1 is the first row of the file.)If importing a condition, the content of this row is ignored.- Returns:
- maximumInterpolationRow
-
setMaximumInterpolationRow
-
name
-
getName
Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.- Returns:
- name
-
setName
-
namePrefix
-
getNamePrefix
Prefix prepended to the name of each signal when importing signal(s) and prepended to the name of each capsule property when importing a condition. Leading whitespace is ignored.- Returns:
- namePrefix
-
setNamePrefix
-
nameRow
-
getNameRow
Integer that identifies the header row used to name the signal(s) when importing signal(s) and used to name the capsule properties when importing a condition. If not specified, defaults to 1 (first row). The name row is required and must have unique non-whitespace entries.- Returns:
- nameRow
-
setNameRow
-
nameSuffix
-
getNameSuffix
Suffix appended to the name of each signal when importing signal(s) and appended to the name of each capsule property when importing a condition. Trailing whitespace is ignored.- Returns:
- nameSuffix
-
setNameSuffix
-
properties
-
addPropertiesItem
-
getProperties
Get properties- Returns:
- properties
-
setProperties
-
scopedTo
-
getScopedTo
The ID of the workbook to which this item will be scoped.- Returns:
- scopedTo
-
setScopedTo
-
timeZone
-
getTimeZone
If the timestamps (key for signals, start/end for a condition) contain no time zone information, they will be interpreted as being in this time zone. If not specified and the timestamps contain no time zone information, the time zone of the Seeq server is used. If the timestamps contain time zone information, this setting is ignored.- Returns:
- timeZone
-
setTimeZone
-
uploadFilename
-
getUploadFilename
The server-side name of the CSV file that is returned from the upload endpoint.- Returns:
- uploadFilename
-
setUploadFilename
-
validationMode
-
getValidationMode
The approach to use when CSV data cannot be parsed. Choices are Fail, Skip, Invalid. If Fail (default), then cells that cannot be parsed will cause the import to fail with error messages.If Skip, those cells will be skipped meaning that no sample will be created for signals from that row of the file. For conditions, if it is the start or end cell, no capsule will be created from that row. If the cell is a capsule property, the capsule is still created but without that capsule property. If Invalid and the cell is a sample key or capsule start/end, no sample or capsule is created from that row of the file. If the cell is a sample value or capsule property, the sample or capsule property is created with the value INVALID.- Returns:
- validationMode
-
setValidationMode
-
valueColumnIndices
-
getValueColumnIndices
List of integers identifying the columns to import. When importing signals, these columns will be combined with the key column to create signals. When importing a condition, these columns will become the capsule properties. Valid formats are a comma separated list of 'N' or 'N-M' where N and M are integers greater than zero and M >= N. Example: '2, 5-7, 10, 12-14'. The first column of the file is column 1. If the column(s) representing a signal key or condition start/end is included in the list, it will be ignored. If neither valueColumnNames nor valueColumnIndices are specified, all columns other than the key/start/end column will result in signals when importing signals and will result in capsule properties when importing a condition. An entry of 0 alone indicates that no columns should be imported as capsule properties. If a column in this list cannot be found in the file, the import will fail. Any column is only imported once no matter how many times it is listed.- Returns:
- valueColumnIndices
-
setValueColumnIndices
-
valueColumnNames
-
getValueColumnNames
List of comma separated case sensitive names of the columns to import. When importing signals, these columns will be combined with the key column to create signals. When importing a condition, these columns will become the capsule properties. If the column(s) representing a signal key or condition start/end is included in the list, it will be ignored. If not specified, valueColumnIndices will be used. If specified, valueColumnIndices will be ignored. If a column name in this list cannot be found in the file, the import will fail. Any column is only imported once no matter how many times it is listed.- Returns:
- valueColumnNames
-
setValueColumnNames
-
valueUom
-
getValueUom
The unit of measure to be used for every signal when importing signals and for every capsule property when importing a condition. If not specified, defaults to unitless. If a unit of measure row is specified, the information in that row overrides this setting. If this unit of measure is not recognized, the import will fail.- Returns:
- valueUom
-
setValueUom
-
valueUomRow
-
getValueUomRow
Integer that identifies the row containing the unit of measure for each signal when importing signal(s) or for each capsule property when importing a condition. If there is no such row, set to 0. If not specified, defaults to 0. If a unit of measure in the row is not recognized, unitless will be used instead. (Row 1 is the first row of the file.)- Returns:
- valueUomRow
-
setValueUomRow
-
equals
-
hashCode
public int hashCode() -
toString
-