no.petroware.logio.las

Class LasFile

java.lang.Object

no.petroware.logio.las.LasFile

public final class LasFile
extends Object

Class representing the content of one logical LAS file.

A LAS file is a collection of metadata sections and curves.

Author:

Petroware AS

Constructor Summary

Constructors

Constructor and Description
LasFile(String name, LasVersion version) Create an empty LAS file instance that can be populated with data and later saved to disk.

Method Summary

Modifier and Type	Method and Description
void	addCurve(LasCurve curve) Add the specified curve to the default definition section of this LAS file.
void	addCurve(String definitionSectionName, LasCurve curve) Add the specified curve to this LAS file and associate it with the section of the given name.
void	addSection(LasSection section) Add the specified section to this LAS file.
void	clearCurves() Clear all curves of this LAS file.
void	clearCurves(LasSection dataSection) Clear the curves of the specified data section.
LasSection	findDataSection(LasSection definitionSection) Find the data section of a given definition section.
LasSection	findOtherSection() Find the "other" section of this LAS file.
LasSection	findParameterSection() Find the parameter section of this LAS file.
LasSection	findSection(String name) Find the first section starting with the specified name.
LasSection	findVersionSection() Find the version section of this file.
LasSection	findWellSection() Find the well section of this LAS file.
List<LasCurve>	getCurves() Return the curves of this LAS file.
List<LasCurve>	getCurves(LasSection dataSection) Return the curves of the specified data section.
List<LasSection>	getDataSections() Return all the data sections of this LAS file.
char	getFieldDelimiter() Get the data field delimiter of this LAS file.
String	getName() Return the name of this LAS file.
String	getNoValue() Get the string that defines no-value for this LAS file when the file is written to disk.
String	getParameterValue(String parameterName) Return the value of the specified parameter.
Date	getParameterValueAsDate(LasSection section, String parameterName) Return the specified parameter in the given section as a date.
Double	getParameterValueAsDouble(LasSection section, String parameterName) Return the value of the specified parameter as a double.
List<LasSection>	getSections() Return all the sections of this LAS file.
LasVersion	getVersion() Return the version of this LAS file.
boolean	hasCurveData() Check if this LAS file instance contains bulk data.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LasFile

public LasFile(String name,
               LasVersion version)

Create an empty LAS file instance that can be populated with data and later saved to disk.

The mandatory ~Version section will be auto-populated.

The mandatory ~Well section must be created by the client, but parameters associated with the curve data (STRT, STOP, STEP and NULL) will be auto-populated if the well section is present.

Required parameter sections must be provided by the client.

Definition and data section(s) will be auto-populated based on provided curves.

The instance may be written to file using LasFileWriter.

Parameters:

name - Name of LAS file. Null if none.

version - LAS version. Non-null.

Throws:

IllegalArgumentException - If version is null.

Method Detail

getName

public String getName()

Return the name of this LAS file. Typically the name of the back-end disk file, or null if not set.

Returns:

Name of this file. May be null.

getSections

public List<LasSection> getSections()

Return all the sections of this LAS file.

Returns:

All the sections of this LAS file. Never null.

getDataSections

public List<LasSection> getDataSections()

Return all the data sections of this LAS file.

For a LAS 2.0 file this will be at most one, while for LAS 3.0 it may be several. In any case, the associated curves can be retrieved by the getCurves(LasSection dataSection) method.

Returns:

All the data sections of this LAS file. Never null.

addSection

public void addSection(LasSection section)

Add the specified section to this LAS file.

Parameters:

section - Section to add. Non-null.

Throws:

IllegalArgumentException - If section is null.

findSection

public LasSection findSection(String name)

Find the first section starting with the specified name. The search is case insensitive.

Parameters:

name - (Start of) name of section to find. "W" or "WELL" will return the "~Well" section and so on. Non-null.

Returns:

The requested section, or null if not found.

Throws:

IllegalArgumentException - If name is null.

findVersionSection

public LasSection findVersionSection()

Find the version section of this file.

Returns:

Version section of this file. Never null.

getVersion

public LasVersion getVersion()

Return the version of this LAS file.

Returns:

Version of this LAS file. Never null.

findWellSection

public LasSection findWellSection()

Find the well section of this LAS file. The well section is mandatory in LAS files, but if this instance originates from a file where it was not present, it may still be absent.

Returns:

Well section of this LAS file. Null if not found.

findParameterSection

public LasSection findParameterSection()

Find the parameter section of this LAS file. This method is most useful for LAS 2.0 files where there is exactly one parameter section of a predefined name. In LAS 3.0 there may be several parameter sections with arbitrary names.

Returns:

Parameter section of this LAS file. Null if not found.

findDataSection

public LasSection findDataSection(LasSection definitionSection)

Find the data section of a given definition section.

A data section will have an association pointer to its definition as follows:

    ~XXX_Definition

    ~XXX_Data | XXX_Definition
 

Passing the XXX_Definition section into this method will return the XXX_Data section.

For LAS 2.0 there is an implicit association between the "CURVE" section and the corresponding "ASCII" section which is handled in this method.

Parameters:

definitionSection - Section to find data section of. Non-null.

Returns:

Associated data section, or null if non-existing.

Throws:

IllegalArgumentException - If definitionSection is null.

findOtherSection

public LasSection findOtherSection()

Find the "other" section of this LAS file. This section is a feature of LAS version <= 2.0 only.

Returns:

Other section of this LAS file. Null if not found.

getFieldDelimiter

public char getFieldDelimiter()

Get the data field delimiter of this LAS file. The field delimiter is defined in the DLM parameter of the version section. For LAS 2.0 the field delimiter is always ' '.

Returns:

Field delimiter character of this file. One of ' ', ',' or '\t'. If it is not defined, ' ' is returned.

getNoValue

public String getNoValue()

Get the string that defines no-value for this LAS file when the file is written to disk.

The no-value is defined in the NULL parameter of the ~WELL section.

NOTE: This is for information only; The client program should use null consistently when specifying or testing for no-value.

Returns:

No-value of this file, or the default if not found. Never null.

getCurves

public List<LasCurve> getCurves(LasSection dataSection)

Return the curves of the specified data section.

This methods is typically used with files of LAS 3.0.

For LAS 2.0 this method can be called with the ASCII section as argument, or getCurves() (without arguments) can be used.

At first invocation the data section is parsed and converted to the list of curves. The data records contained in the data section are removed after invocation to conserve memory. Subsequent invocations return a buffered list of curves.

Parameters:

dataSection - The data section to find curves of. Non-null.

Returns:

The requested curves. Never null. The first curve in the list is always the index curve.

Throws:

IllegalArgumentException - If dataSection is null.

getCurves

public List<LasCurve> getCurves()

Return the curves of this LAS file.

This methods is typically used with files of LAS 2.0 where there is only one set of curves.

Returns:

The curves of this LAS file. Never null. The first curve in the list is always the index curve.

clearCurves

public void clearCurves()

Clear all curves of this LAS file. This method is typically used with files of LAS 2.0 where there is only one set of curves.

clearCurves

public void clearCurves(LasSection dataSection)

Clear the curves of the specified data section. This method is typically used with files of LAS 3.0 where multiple data sections are possible. For LAS 2.0 the clearCurves() (without an argument) can be used for the same purpose.

Parameters:

dataSection - The data section to clear the curves of. Non-null

Throws:

IllegalArgumentException - If dataSection is null or not of LasSection.Type.DATA.

addCurve

public void addCurve(String definitionSectionName,
                     LasCurve curve)

Add the specified curve to this LAS file and associate it with the section of the given name.

The first curve added to a section will be the index curve. Curves should be prepopulated with values, and should all have the same number of values.

If this is LAS 2.0 the specified section name is not used as the definition and data sections are implicit. Null may be specified in this case. If this is LAS 3.0 the specified section name must be without the "~" prefix and "_Definition"/"_Data" suffix. If null is specified, the default "Log" name is being used.

If a well section has been added to the LAS file instance prior to calling addCurve, the STRT, STOP and STEP entries will automatically be included if they are not present already. If they are present, no validation will be done on these entries.

If values are added to the curves after they are added to the LAS file instance, the client must take responsibility for the STRT, STOP and STEP entries.

Parameters:

definitionSectionName - Name of definition section to add to. Null for default.

curve - Curve to add. Non-null.

Throws:

IllegalArgumentException - If curve is null or if it has an invalid number or values.

addCurve

public void addCurve(LasCurve curve)

Add the specified curve to the default definition section of this LAS file.

The first curve added will be the index curve. Curves should be prepopulated with values, and should all have the same number of values.

If a well section has been added to the LAS file instance prior to calling addCurve, the STRT, STOP and STEP entries will automatically be included if they are not present already. If they are present, no validation will be done on these entries.

If values are added to the curves after they are added to the LAS file instance, the client must take responsibility for the STRT, STOP and STEP entries.

Parameters:

curve - Curve to add. Non-null.

Throws:

IllegalArgumentException - If curve is null or if it has an invalid number or values.

getParameterValue

public String getParameterValue(String parameterName)

Return the value of the specified parameter. Search all parameter sections.

Parameters:

parameterName - Name of parameter to get value of. Non-null.

Returns:

The requested parameter value, or null if the value is unspecified or the parameter is not found.

Throws:

IllegalArgumentException - If parameterName is null.

getParameterValueAsDouble

public Double getParameterValueAsDouble(LasSection section,
                                        String parameterName)

Return the value of the specified parameter as a double.

NOTE: This method is at the file level rather than the section level as no-values needs to be resolved. The no-value concept is defined at the file level.

Parameters:

section - Section to query. Null to search all sections.

parameterName - Name of parameter to get value of. Non-null.

Returns:

The parameter value as a double, or null if it is no-value, if it doesn't exist or isn't numeric.

Throws:

IllegalArgumentException - If parameterName is null.

getParameterValueAsDate

public Date getParameterValueAsDate(LasSection section,
                                    String parameterName)

Return the specified parameter in the given section as a date.

If the parameter is not found, or if the parameter isn't a valid date, null is returned. Several date formats are checked in order to parse the parameter value.

NOTE: This method is at the file level rather than the section level as no-values needs to be resolved. The no-value concept is defined at the file level.

Parameters:

section - Section to find value from. Null to search all sections.

parameterName - Name of parameter to get date of. Non.null.

Returns:

The requested date, or null if it is no-value, not found or not of date type.

Throws:

IllegalArgumentException - If parameterName is null.

hasCurveData

public boolean hasCurveData()

Check if this LAS file instance contains bulk data.

Returns:

True if the instance contains curve data, false otherwise.

toString

public String toString()

Overrides:

toString in class Object