JsonLog (Log I/O)

java.lang.Object
- no.petroware.logio.json.JsonLog

```
public final class JsonLog
extends Object
```
Class representing the content of one JSON Well Log Format log. A log consists of a header, curve definitions, and curve data.

Author:

Petroware AS

See Also:

https://jsonwelllogformat.org

Constructor Summary

Constructors
Constructor and Description
`JsonLog()` Create an empty JSON Well Log Format log instance.
`JsonLog(JsonLog log, boolean includeCurveValues)` Create a JSON Well Log Format log instance as a copy of the specified log.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCurve(JsonCurve curve)` Add the specified curve to this log.
`void`	`addTable(JsonTable table)` Add the specified property table to this log.
`void`	`addTable(JsonTable table, boolean mergeTable)` Add the specified property table to this log.
`void`	`clearCurves()` Clear curve data from all curves of this log.
`JsonCurve`	`findCurve(String curveName)` Return curve of the specified name from this log.
`int`	`findCurveNo(String curveName)` Return curve number of the curve with the specified name.
`Object`	`getActualEndIndex()` Return the actual end index of this log.
`Object`	`getActualStartIndex()` Return the actual start index of this log.
`Double`	`getActualStep()` Return the actual step of the index curve of this log.
`String`	`getCountry()` Return country of this log.
`JsonCurve`	`getCurve(int curveNo)` Return the specified curve from this log.
`List<JsonCurve>`	`getCurves()` Return the curves of this log.
`String`	`getDataUri()` Return URI location of the data object in case this is kept separate.
`Date`	`getDate()` Return logging date of this log.
`String`	`getDescription()` Get description of this log.
`String`	`getElevation()` Return elevation of this log.
`Object`	`getEndIndex()` Return end index of this log.
`String`	`getField()` Return field name of this log.
`javax.json.JsonObject`	`getHeader()` Return the header of this log as a single JSON object.
`JsonCurve`	`getIndexCurve()` Return the index curve of this log.
`Class<?>`	`getIndexValueType()` Return value type of the index of this log, typically Double.class or Date.class.
`String`	`getName()` Return name of this log.
`int`	`getNCurves()` Return the number of curves in this log.
`int`	`getNValues()` Return the number of values (per curve) in this log.
`String`	`getOperator()` Return operator name of this log.
`Set<String>`	`getProperties()` Return all the header property keys of this log.
`Object`	`getProperty(String key)` Return header property for the specified key.
`Boolean`	`getPropertyAsBoolean(String key)` Return header property for the specified key as a boolean.
`Date`	`getPropertyAsDate(String key)` Return header property for the specified key as date.
`Double`	`getPropertyAsDouble(String key)` Return header property for the specified key as a double.
`Integer`	`getPropertyAsInteger(String key)` Return header property for the specified key as an integer.
`String`	`getPropertyAsString(String key)` Return header property for the specified key as a string.
`String`	`getRunNumber()` Return run number of this log.
`String`	`getServiceCompany()` Return service company name of this log.
`String`	`getSource()` Return the source (system or process) of this log.
`Object`	`getStartIndex()` Return start index of this log.
`Double`	`getStep()` Return the regular step of this log.
`JsonTable`	`getTable(String tableName)` Return property table of the specified name.
`List<JsonTable>`	`getTables()` Return all property tables from the header.
`String`	`getWell()` Return well name of this log.
`String`	`getWellbore()` Return wellbore name of this log.
`boolean`	`hasCurveData()` Return whether the JSON log instance includes curve data or not, i.e. if only header data was read or created.
`void`	`setCountry(String country)` Set country of this log.
`void`	`setDataUri(String dataUri)` Set URI for the data object in case this is kept separate.
`void`	`setDate(Date date)` Set logging date of this log.
`void`	`setDescription(String description)` Set description of this log.
`void`	`setElevation(double elevation)` Set elevation of this log.
`void`	`setEndIndex(Object endIndex)` Set end index of this log in the header.
`void`	`setField(String field)` Set field name of this log.
`void`	`setHeader(javax.json.JsonObject header)` Set the header of this instance.
`void`	`setName(String name)` Set name of this log.
`void`	`setOperator(String operator)` Set operator name of this log.
`void`	`setProperty(String key, Object value)` Set a string header property of this log.
`void`	`setRunNumber(String runNumber)` Set run number of this log.
`void`	`setServiceCompany(String serviceCompany)` Set service company name of this log.
`void`	`setSource(String source)` Set source (system or process) of this log.
`void`	`setStartIndex(Object startIndex)` Set start index of this log in header.
`void`	`setStep(Double step)` Set the regular step of the index curve of this log.
`void`	`setWell(String well)` Set well name of this log.
`void`	`setWellbore(String wellbore)` Set wellbore name of this log.
`String`	`toString()`

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

- Constructor Detail
  - JsonLog
```
public JsonLog()
```
    Create an empty JSON Well Log Format log instance.
  - JsonLog
```
public JsonLog(JsonLog log,
               boolean includeCurveValues)
```
    Create a JSON Well Log Format log instance as a copy of the specified log.
    
    Parameters:
    
    log - Log to copy. Non-null.
    
    includeCurveValues - True to include curve values in the copy, false if not.
    
    Throws:
    
    IllegalArgumentException - If log is null.
- Method Detail
  - hasCurveData
```
public boolean hasCurveData()
```
    Return whether the JSON log instance includes curve data or not, i.e. if only header data was read or created.
    
    Returns:
    
    True if bulk (curve) data is present, false otherwise.
  - setHeader
```
public void setHeader(javax.json.JsonObject header)
```
    Set the header of this instance.
    
    Parameters:
    
    header - JSON header object. Non-null.
    
    Throws:
    
    IllegalArgumentException - If header is null.
  - getHeader
```
public javax.json.JsonObject getHeader()
```
    Return the header of this log as a single JSON object.
    
    Returns:
    
    Header of this log. Never null.
  - setProperty
```
public void setProperty(String key,
                        Object value)
```
    Set a string header property of this log.
    
    Parameters:
    
    key - Key of property to set. Non-null.
    
    value - Associated value. Null to unset. Must be of type BigDecimal, BigInteger, Boolean, Double, Integer, Long, String, Date or JsonValue.
    
    Throws:
    
    IllegalArgumentException - If key is null or value is not of a legal primitive type.
  - getProperties
```
public Set<String> getProperties()
```
    Return all the header property keys of this log.
    
    Returns:
    
    All property keys of this log. Never null.
  - getProperty
```
public Object getProperty(String key)
```
    Return header property for the specified key.
    This is a generic method for clients that knows custom content of the well log. It is up to the client program to parse the returned content into the appropriate type.
    
    Parameters:
    
    key - Key of property to get. Non-null.
    
    Returns:
    
    The associated value, or null if not found.
    
    Throws:
    
    IllegalArgumentException - If key is null.
  - getPropertyAsString
```
public String getPropertyAsString(String key)
```
    Return header property for the specified key as a string.
    
    Parameters:
    
    key - Key of property to get. Non-null.
    
    Returns:
    
    The associated value as a string. Null if not found, or not compatible with the string type.
    
    Throws:
    
    IllegalArgumentException - If key is null.
  - getPropertyAsDouble
```
public Double getPropertyAsDouble(String key)
```
    Return header property for the specified key as a double.
    
    Parameters:
    
    key - Key of property to get. Non-null.
    
    Returns:
    
    The associated value as a double. Null if not found, or not compatible with the double type.
    
    Throws:
    
    IllegalArgumentException - If key is null.
  - getPropertyAsInteger
```
public Integer getPropertyAsInteger(String key)
```
    Return header property for the specified key as an integer.
    
    Parameters:
    
    key - Key of property to get. Non-null.
    
    Returns:
    
    The associated value as an integer. Null if not found, or not compatible with the integer type.
    
    Throws:
    
    IllegalArgumentException - If key is null.
  - getPropertyAsBoolean
```
public Boolean getPropertyAsBoolean(String key)
```
    Return header property for the specified key as a boolean.
    
    Parameters:
    
    key - Key of property to get. Non-null.
    
    Returns:
    
    The associated value as a boolean. Null if not found, or not compatible with the boolean type.
    
    Throws:
    
    IllegalArgumentException - If key is null.
  - getPropertyAsDate
```
public Date getPropertyAsDate(String key)
```
    Return header property for the specified key as date.
    
    Parameters:
    
    key - Key of property to get. Non-null.
    
    Returns:
    
    The associated value as a date. Null if not found, or not compatible with the date type.
    
    Throws:
    
    IllegalArgumentException - If key is null.
  - getTables
```
public List<JsonTable> getTables()
```
    Return all property tables from the header.
    
    Returns:
    
    All property tables from the header. Never null.
  - getTable
```
public JsonTable getTable(String tableName)
```
    Return property table of the specified name.
    
    Parameters:
    
    tableName - Name of property table to get.
    
    Returns:
    
    The requested table, or null if not present.
    
    Throws:
    
    IllegalArgumentException - If tableName is null.
  - addTable
```
public void addTable(JsonTable table)
```
    Add the specified property table to this log.
    
    Parameters:
    
    table - Table to add. Non-null.
    
    Throws:
    
    IllegalArgumentException - If table is null or a table with the same name already exists.
  - addTable
```
public void addTable(JsonTable table,
                     boolean mergeTable)
```
    Add the specified property table to this log. Attempts to merge with existing table (if there is one).
    
    Parameters:
    
    table - Table to add. Non-null.
    
    mergeTable - True if should merge new table with existing table. Otherwise addTable(table) is called.
    
    Throws:
    
    IllegalArgumentException - If table is null or mergeTable is false and a table with the same name already exists.
    
    IllegalStateException - If table cannot be merged.
  - getName
```
public String getName()
```
    Return name of this log.
    
    Returns:
    
    Name of this log. Null if none provided.
  - setName
```
public void setName(String name)
```
    Set name of this log.
    
    Parameters:
    
    name - Name to set. Null to unset.
  - getDescription
```
public String getDescription()
```
    Get description of this log.
    
    Returns:
    
    Description of this log. Null if none provided.
  - setDescription
```
public void setDescription(String description)
```
    Set description of this log.
    
    Parameters:
    
    description - Description to set. Null to unset.
  - getWell
```
public String getWell()
```
    Return well name of this log.
    
    Returns:
    
    Well name of this log. Null if none provided.
  - setWell
```
public void setWell(String well)
```
    Set well name of this log.
    
    Parameters:
    
    well - Well name to set. Null to unset.
  - getWellbore
```
public String getWellbore()
```
    Return wellbore name of this log.
    
    Returns:
    
    Wellbore name of this log. Null if none provided.
  - setWellbore
```
public void setWellbore(String wellbore)
```
    Set wellbore name of this log.
    
    Parameters:
    
    wellbore - Wellbore name to set. Null to unset.
  - getField
```
public String getField()
```
    Return field name of this log.
    
    Returns:
    
    Field name of this log. Null if none provided.
  - setField
```
public void setField(String field)
```
    Set field name of this log.
    
    Parameters:
    
    field - Field name to set. Null to unset.
  - getCountry
```
public String getCountry()
```
    Return country of this log.
    
    Returns:
    
    Country of this log. Null if none provided.
  - setCountry
```
public void setCountry(String country)
```
    Set country of this log.
    
    Parameters:
    
    country - Country to set. Null to unset.
  - getDate
```
public Date getDate()
```
    Return logging date of this log.
    
    Returns:
    
    Logging date of this log. Null if none provided.
  - setDate
```
public void setDate(Date date)
```
    Set logging date of this log.
    
    Parameters:
    
    date - Logging date to set. Null to unset.
  - getOperator
```
public String getOperator()
```
    Return operator name of this log.
    
    Returns:
    
    Operator name of this log. Null if none provided.
  - setOperator
```
public void setOperator(String operator)
```
    Set operator name of this log.
    
    Parameters:
    
    operator - Operator name to set. Null to unset.
  - getServiceCompany
```
public String getServiceCompany()
```
    Return service company name of this log.
    
    Returns:
    
    Service company name of this log. Null if none provided.
  - setServiceCompany
```
public void setServiceCompany(String serviceCompany)
```
    Set service company name of this log.
    
    Parameters:
    
    serviceCompany - Service company name of this log. Null to unset.
  - getRunNumber
```
public String getRunNumber()
```
    Return run number of this log.
    
    Returns:
    
    Run number of this log. Null if none provided.
  - setRunNumber
```
public void setRunNumber(String runNumber)
```
    Set run number of this log.
    
    Parameters:
    
    runNumber - Run number of this log. Null to unset.
  - getElevation
```
public String getElevation()
```
    Return elevation of this log.
    
    Returns:
    
    Elevation of this log. Null if none provided.
  - setElevation
```
public void setElevation(double elevation)
```
    Set elevation of this log.
    
    Parameters:
    
    elevation - Elevation of this log. Null to unset.
  - getSource
```
public String getSource()
```
    Return the source (system or process) of this log.
    
    Returns:
    
    Source of this log. Null if none provided.
  - setSource
```
public void setSource(String source)
```
    Set source (system or process) of this log.
    
    Parameters:
    
    source - Source of this log. Null to unset.
  - getDataUri
```
public String getDataUri()
```
    Return URI location of the data object in case this is kept separate.
    
    Returns:
    
    URI location of the data object. Null if data is kept locale.
  - setDataUri
```
public void setDataUri(String dataUri)
```
    Set URI for the data object in case this is kept separate.
    
    Parameters:
    
    dataUri - URI to the data object. Null if data is kept local.
  - getIndexValueType
```
public Class<?> getIndexValueType()
```
    Return value type of the index of this log, typically Double.class or Date.class.
    
    Returns:
    
    Value type of the index of this log. Never null. If the log has no curves, Double.class is returned.
  - getStartIndex
```
public Object getStartIndex()
```
    Return start index of this log.
    NOTE: This property is taken from the header, and may not necessarily be in accordance with the actual data of the log.
    
    Returns:
    
    Start index of this log. The type will be according to the type of the index curve, @see #getIndexValueType.
  - getActualStartIndex
```
public Object getActualStartIndex()
```
    Return the actual start index of this log.
    
    Returns:
    
    The actual start index of this log. Null if the log has no values.
  - setStartIndex
```
public void setStartIndex(Object startIndex)
```
    Set start index of this log in header.
    
    Parameters:
    
    startIndex - Start index to set. Null to unset. The type should be in accordance with the actual type of the index curve of the log.
  - getEndIndex
```
public Object getEndIndex()
```
    Return end index of this log.
    NOTE: This property is taken from header, and may not necessarily be in accordance with the actual data of the log.
    
    Returns:
    
    End index of this log. The type will be according to the type of the index curve, @see #getIndexValueType.
  - getActualEndIndex
```
public Object getActualEndIndex()
```
    Return the actual end index of this log.
    
    Returns:
    
    The actual end index of this log. Null if the log has no values.
  - setEndIndex
```
public void setEndIndex(Object endIndex)
```
    Set end index of this log in the header.
    
    Parameters:
    
    endIndex - End index to set. Null to unset. The type should be in accordance with the actual type of the index curve of the log.
  - getStep
```
public Double getStep()
```
    Return the regular step of this log.
    NOTE: This property is taken from header, and may not necessarily be in accordance with the actual data on the file.
    
    Returns:
    
    The step of the index curve of this log. Null should indicate that the log in irregular or the step is unknown.
  - getActualStep
```
public Double getActualStep()
```
    Return the actual step of the index curve of this log.
    
    Returns:
    
    The actual step of the index curve. Null if the log has no data or the log set is irregular.
  - setStep
```
public void setStep(Double step)
```
    Set the regular step of the index curve of this log.
    
    Parameters:
    
    step - Step to set. Null to indicate unknown or that the index is irregular. If the log set is time based, the step should be the number of milliseconds between samples.
  - addCurve
```
public void addCurve(JsonCurve curve)
```
    Add the specified curve to this log. The first curve added to a log is by convention the index curve.
    
    Parameters:
    
    curve - Curve to add. Non-null.
    
    Throws:
    
    IllegalArgumentException - If curve is null.
  - getCurves
```
public List<JsonCurve> getCurves()
```
    Return the curves of this log. The first curve is by convention always the index curve.
    
    Returns:
    
    The curves of this log. Never null.
  - getCurve
```
public JsonCurve getCurve(int curveNo)
```
    Return the specified curve from this log.
    
    Parameters:
    
    curveNo - Curve number of curve to return. [0,nCurves>.
    
    Returns:
    
    The requested curve. Never null.
    
    Throws:
    
    IllegalArgumentException - If curveNo is out of bound.
  - findCurve
```
public JsonCurve findCurve(String curveName)
```
    Return curve of the specified name from this log.
    If there happens to be more than one curve with this name the first one encountered is returned.
    
    Parameters:
    
    curveName - Name of curve to find.
    
    Returns:
    
    The requested curve, or null if not found.
    
    Throws:
    
    IllegalArgumentException - If curveName is null.
  - findCurveNo
```
public int findCurveNo(String curveName)
```
    Return curve number of the curve with the specified name.
    If there happens to be more than one curve with this name the first one encountered is returned.
    
    Parameters:
    
    curveName - Name of curve to find.
    
    Returns:
    
    The requested curve number, or -1 if not found.
    
    Throws:
    
    IllegalArgumentException - If curveName is null.
  - getNCurves
```
public int getNCurves()
```
    Return the number of curves in this log.
    
    Returns:
    
    Number of curves in this log. [0,>.
  - getNValues
```
public int getNValues()
```
    Return the number of values (per curve) in this log.
    
    Returns:
    
    Number of values in this log. [0,>.
  - getIndexCurve
```
public JsonCurve getIndexCurve()
```
    Return the index curve of this log.
    
    Returns:
    
    The index curve of this log, or null if the log doesn't contain any curves.
  - clearCurves
```
public void clearCurves()
```
    Clear curve data from all curves of this log.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class JsonLog

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JsonLog

JsonLog

Method Detail

hasCurveData

setHeader

getHeader

setProperty

getProperties

getProperty

getPropertyAsString

getPropertyAsDouble

getPropertyAsInteger

getPropertyAsBoolean

getPropertyAsDate

getTables

getTable

addTable

addTable

getName

setName

getDescription

setDescription

getWell

setWell

getWellbore

setWellbore

getField

setField

getCountry

setCountry

getDate

setDate

getOperator

setOperator

getServiceCompany

setServiceCompany

getRunNumber

setRunNumber

getElevation

setElevation

getSource

setSource

getDataUri

setDataUri

getIndexValueType

getStartIndex

getActualStartIndex

setStartIndex

getEndIndex

getActualEndIndex

setEndIndex

getStep

getActualStep

setStep

addCurve

getCurves

getCurve

findCurve

findCurveNo

getNCurves

getNValues

getIndexCurve

clearCurves

toString