public static class WitsmlLog.Curve extends Object implements Comparable<WitsmlLog.Curve>
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlLog.Curve.DataType
The endcoding allowed in a realtime channel value or log curve value.
|
static class |
WitsmlLog.Curve.Origin |
static class |
WitsmlLog.Curve.State |
Modifier and Type | Method and Description |
---|---|
AxisDefinition |
addAxisDefinition() |
int |
compareTo(WitsmlLog.Curve curve) |
List<AxisDefinition> |
getAxisDefinitions()
Return the axis definitions of this curve.
|
Integer |
getClassIndex()
Return the class index of this curve.
|
Integer |
getCurveNo()
Return the curve no of this curve.
|
Value |
getDataDensity()
Return the data density of this curve.
|
String |
getDataSource()
Return the data source of this curve.
|
Class<?> |
getDataType()
Return the data type of this curve.
|
String |
getDescription()
Return the description of this curve.
|
String |
getId()
Return the ID of this curve.
|
Object |
getLastValue()
Return the last value of this curve.
|
WitsmlLog |
getLog()
Return the log owner of this curve.
|
Value |
getMaxIndex()
Return the max index of this curve.
|
Date |
getMaxTimeIndex()
Return the max time index of this curve.
|
Value |
getMinIndex()
Return the min index of this curve.
|
Date |
getMinTimeIndex()
Return the min time index of this curve.
|
String |
getMnemonic()
Return the mnemonic of this curve.
|
String |
getName()
Return the name of this curve.
|
int |
getNDimensions()
Return number of dimensions in this curve.
|
String |
getNoValue()
Return the no value of this curve.
|
int |
getNValues()
Return the number of values in this curve.
|
WitsmlLog.Curve.Origin |
getOrigin()
Return the origin of this curve.
|
String |
getQuantity()
Return the quantity of this curve.
|
Object[] |
getRange()
Return the range of this curve, i.e array of two containing
the minimum and maximum available data value.
|
Value |
getSensorOffset()
Return the sensor offset of this curve.
|
WitsmlLog.Curve.State |
getState()
Return the state of this curve.
|
String |
getUnit()
Return the unit of this curve.
|
Object |
getValue(int index)
Return the index'th value of (the first dimension of) this curve.
|
Object |
getValue(int dimension,
int index)
Return the index'th value of specified dimension of this curve.
|
List<Object> |
getValues()
Return the values of (the first dimension of) this curve.
|
List<Object> |
getValues(int dimension)
Return the values of the given dimension of this curve.
|
Reference |
getWellDatum()
Return the well datum of this curve.
|
Boolean |
isAlternateIndex()
Check if this curve is an alternate index for the log.
|
void |
setAlternateIndex(Boolean isAlternateIndex)
Specify wether this curve is an alternate index for the log.
|
void |
setClassIndex(Integer classIndex)
Set the class index of this curve.
|
void |
setDataDensity(Value dataDensity)
Set the data density of this curve.
|
void |
setDataSource(String dataSource)
Set the data source of this curve.
|
void |
setDataType(Class<?> dataType)
Set the data type of this curve.
|
void |
setDataType(WitsmlLog.Curve.DataType dataType)
Set the data type of this curve.
|
void |
setDescription(String description)
Set the description of this curve.
|
void |
setMnemonic(String mnemonic)
Set the mnemonic of this curve.
|
void |
setNoValue(String noValue)
Set the no value of this curve.
|
void |
setOrigin(WitsmlLog.Curve.Origin origin)
Set the origin of this curve.
|
void |
setQuantity(String quantity)
Set the quantity of this curve.
|
void |
setSensorOffset(Value sensorOffset)
Set the sensor offset of this curve.
|
void |
setState(WitsmlLog.Curve.State state)
Set the state of this curve.
|
void |
setUnit(String unit)
Set the unit of this curve.
|
void |
setWellDatum(Reference wellDatum)
Set the well datum of this curve.
|
public int compareTo(WitsmlLog.Curve curve)
compareTo
in interface Comparable<WitsmlLog.Curve>
public WitsmlLog getLog()
public String getId()
public String getName()
Corresponds to the WITSML property mnemonic
:
The curve name.
public String getQuantity()
Corresponds to the WITSML property classWitsml
:
The curve classification obtained from a lookup in the vendors mnemonic catalog.
public void setQuantity(String quantity)
Corresponds to the WITSML property classWitsml
:
The curve classification obtained from a lookup in the vendors mnemonic catalog.
quantity
- The quantity to set.
May be null indicating absent or unknown.public String getUnit()
Corresponds to the WITSML property unit
:
Unit of measurement of the data values.
public void setUnit(String unit)
Corresponds to the WITSML property unit
:
Unit of measurement of the data values.
unit
- The unit to set.
May be null indicating absent or unknown.public String getMnemonic()
Corresponds to the WITSML property mnemAlias
:
Name alias for this trace.
public void setMnemonic(String mnemonic)
Corresponds to the WITSML property mnemAlias
:
Name alias for this trace.
mnemonic
- The mnemonic to set.
May be null indicating absent or unknown.public Integer getClassIndex()
Corresponds to the WITSML property classIndex
:
The count relative to (possibly) repeating values of classWitsml. This is used to indicate something like the first pump, second pump, etc.
public void setClassIndex(Integer classIndex)
Corresponds to the WITSML property classIndex
:
The count relative to (possibly) repeating values of classWitsml.
This is used to indicate something like the first pump, second pump, etc.
classIndex
- The class index to set.
May be null indicating absent or unknown.public String getNoValue()
Corresponds to the WITSML property nullValue
:
An empty string is the default representation of a null value for a
curve (i.e. when the null value representation is not explicitly
defined). If a null value is defined in the logCurveInfo, it
overrides any null value specified at the logHeader level.
An empty string is always a valid null value representation in the
comma delimited list. An empty string is not a valid null value
representation within a space delimited array. Specifying a null
value also makes it easier to transform data back to a legacy
format without having to scan the data to insure that the null
pattern does not exist in the data.
public void setNoValue(String noValue)
Corresponds to the WITSML property nullValue
:
An empty string is the default representation of a null value for a
curve (i.e. when the null value representation is not explicitly
defined). If a null value is defined in the logCurveInfo, it overrides
any null value specified at the logHeader level. An empty string is
always a valid null value representation in the comma delimited list.
An empty string is not a valid null value representation within a
space delimited array. Specifying a null value also makes it easier
to transform data back to a legacy format without having to scan the
data to insure that the null pattern does not exist in the data.
noValue
- The no value to set.
May be null indicating absent or unknown.public Boolean isAlternateIndex()
Corresponds to the WITSML property alternateIndex
:
True (true or 1) if this curve is a candidate to be a primary index. False
(false or 0) or not given, indicates otherwise. An index curve should monotonically
change when sorted on its own values (i.e., no duplicates).
public void setAlternateIndex(Boolean isAlternateIndex)
Corresponds to the WITSML property alternateIndex
:
True (true or 1) if this curve is a candidate to be a primary index. False
(false or 0) or not given, indicates otherwise. An index curve should monotonically
change when sorted on its own values (i.e., no duplicates).
isAlternateIndex
- If this curve is an alternate index for the log.public Reference getWellDatum()
Corresponds to the WITSML property wellDatum
:
A pointer to the wellDatum that represents the values of this trace. This is only relevant for measured depths, vertical depths or elevations.
public void setWellDatum(Reference wellDatum)
Corresponds to the WITSML property wellDatum
:
A pointer to the wellDatum that represents the values of this trace. This is only relevant for measured depths, vertical depths or elevations.
wellDatum
- The well datum to set.
May be null indicating absent or unknown.public Value getMinIndex()
Corresponds to the WITSML property minIndex
:
The minimum index value at which the first valid data point is located. This value will be properly set by the server to reflect data in the returned document.
public Value getMaxIndex()
Corresponds to the WITSML property maxIndex
:
The maximum index value at which the last valid data point is located. This value will be properly set by the server to reflect data in the returned document.
public Date getMinTimeIndex()
Corresponds to the WITSML property minDateTimeIndex
:
The minimum index value at which the first valid data point is located. This value will be properly set by the server to reflect data in the returned document.
public Date getMaxTimeIndex()
Corresponds to the WITSML property maxDateTimeIndex
:
The maximum index value at which the last valid data point is located. This value will be properly set by the server to reflect data in the returned document.
public Integer getCurveNo()
Corresponds to the WITSML property columnIndex
:
A 1-based index of data in the LOGDATA.DATA section. A value of zero
indicates an implied curve with no values in the data record.
public String getDescription()
Corresponds to the WITSML property curveDescription
:
Description of the curve.
public void setDescription(String description)
Corresponds to the WITSML property curveDescription
:
Description of the curve.
description
- The description to set.
May be null indicating absent or unknown.public Value getSensorOffset()
Corresponds to the WITSML property sensorOffset
:
Offset of sensor from drill bit. This element is only informative. The measured depth values are at the actual depth (not bit depth from which you must subtract the offset).
public void setSensorOffset(Value sensorOffset)
Corresponds to the WITSML property sensorOffset
:
Offset of sensor from drill bit. This element is only informative. The measured depth values are at the actual depth (not bit depth from which you must subtract the offset).
sensorOffset
- The sensor offset to set.
May be null indicating absent or unknown.public String getDataSource()
Corresponds to the WITSML property dataSource
:
Data source, could be tool name/id.
public void setDataSource(String dataSource)
Corresponds to the WITSML property dataSource
:
Data source, could be tool name/id.
dataSource
- The data source to set.
May be null indicating absent or unknown.public Value getDataDensity()
Corresponds to the WITSML property densData
:
Data density of sample in samples per length unit.
public void setDataDensity(Value dataDensity)
Corresponds to the WITSML property densData
:
Data density of sample in samples per length unit.
dataDensity
- The data density to set.
May be null indicating absent or unknown.public WitsmlLog.Curve.State getState()
Corresponds to the WITSML property traceState
:
State of trace data.
public void setState(WitsmlLog.Curve.State state)
Corresponds to the WITSML property traceState
:
State of trace data.
state
- The state to set.
May be null indicating absent or unknown.public WitsmlLog.Curve.Origin getOrigin()
Corresponds to the WITSML property traceOrigin
:
Origin of trace data.
public void setOrigin(WitsmlLog.Curve.Origin origin)
Corresponds to the WITSML property traceOrigin
:
Origin of trace data.
origin
- The origin to set.
May be null indicating absent or unknown.public Class<?> getDataType()
Corresponds to the WITSML property typeLogData
:
Log data type.
public void setDataType(WitsmlLog.Curve.DataType dataType)
Corresponds to the WITSML property typeLogData
:
Log data type.
dataType
- The data type to set.
May be null indicating absent or unknown.public void setDataType(Class<?> dataType)
Corresponds to the WITSML property typeLogData
:
Log data type.
dataType
- The data type to set.
May be null indicating absent or unknown.public List<AxisDefinition> getAxisDefinitions()
Corresponds to the WITSML property axisDefinition
:
Indicates that the curve is an array curve (i.e., multi-valued samples), and provides meta data by which an axis of the array can be understood.
public AxisDefinition addAxisDefinition()
public int getNDimensions()
public List<Object> getValues(int dimension)
Corresponds to the WITSML property data
:
The actual data corresponding to the curves defined in the LogCurveInfo element. Normally a comma delimited list of data values (see dataDelimiter) with one value for each curve on the log (e.g., "xxx,yyy, zzz"). For array curves, the value of the array curve will be a space delimited list of values that are contained within the commas that delimit the value for that curve (e.g., "xxx,aa bb cc,zzz"). This essentially represents one row of a table where the curve mnemonics represent the column headings.
dimension
- The dimension to get data from. [0,nDimensions>.IllegalArgumentException
- If dimension is out of bounds.public List<Object> getValues()
Corresponds to the WITSML property data
:
The actual data corresponding to the curves defined in the LogCurveInfo element. Normally a comma delimited list of data values (see dataDelimiter) with one value for each curve on the log (e.g., "xxx,yyy, zzz"). For array curves, the value of the array curve will be a space delimited list of values that are contained within the commas that delimit the value for that curve (e.g., "xxx,aa bb cc,zzz"). This essentially represents one row of a table where the curve mnemonics represent the column headings.
public Object getValue(int dimension, int index)
dimension
- Dimension index to get value of. []0,>.index
- Index to get value of [0,n>.ArrayIndexOutOfBoundsException
- If dimension or index is out of bounds.public Object getValue(int index)
index
- Index to get value of [0,n>.ArrayIndexOutOfBoundsException
- If index is not [0,n>.public Object getLastValue()
public Object[] getRange()
If the curves has multiple dimension the range is across all dimensions.
public int getNValues()
Copyright © 2023 Petroware AS - https://petroware.no