public final class DlisFile extends Object
A DlisFile consists of the following elements:
Constructor and Description |
---|
DlisFile()
Create a new DLIS file instance with default header.
|
Modifier and Type | Method and Description |
---|---|
void |
addFrame(DlisFrame frame)
Add the specified frame to this DLIS file.
|
void |
addSet(DlisSet set)
Add the specified set to this DLIS file.
|
DlisFrame |
findFrame(String frameName)
Find frame with the specified name.
|
DlisSet |
findSet(String setType)
Find set of the specified type.
|
List<DlisEncryptedRecord> |
getEncryptedRecords()
Return the encrypted records of this DLIS file.
|
String |
getFileId()
Return the ID of this DLIS file as specified in the
ORIGIN set of the file.
|
List<DlisFrame> |
getFrames()
Return the frames of this DLIS file.
|
DlisFileHeader |
getHeader()
Return the header of this file instance.
|
String |
getName()
Return the name of this file.
|
List<DlisSet> |
getSets()
Return the sets of this DLIS file.
|
String |
getUnit(String objectName,
String attributeName)
Return unit for the specified meta-data attribute of the
specified object.
|
DlisType |
getValue(String objectName,
String attributeName)
Return values for the specified attribute of the specified object.
|
DlisComponent |
getValueComponent(String objectName,
String attributeName)
Return the value component (i.e the instance holding the values
and specifying the unit etc) for the given attribute of the
specified object.
|
List<DlisType> |
getValues(String objectName,
String attributeName)
Return values for the specified attribute of the specified object.
|
boolean |
hasCurveData()
Return whether the DLIS file instance includes curve data
or not, i.e if only header data was read or created.
|
String |
toString() |
public String getName()
public String getFileId()
public DlisFileHeader getHeader()
Note that the file header is a property of the disk file and not the logical DLIS file instance. It is anyway included in each of the sub file instances for convenience.
public boolean hasCurveData()
public List<DlisEncryptedRecord> getEncryptedRecords()
public List<DlisSet> getSets()
public void addSet(DlisSet set)
set
- Set to add. Non-null.IllegalArgumentException
- If set is null.public DlisSet findSet(String setType)
Set types are dictionary controlled. Typical values are "FILE-HEADER", "ORIGIN", "PARAMETER", "CHANNEL", "FRAME" etc. See RP66 V1 Chapter 5. See the DLIS documentation Chapter 5.
setType
- Type of set to find. Non-null.IllegalArgumentException
- If setType is null.public void addFrame(DlisFrame frame)
frame
- Frame to add. Non-null.IllegalArgumentException
- If frame is null.public List<DlisFrame> getFrames()
public DlisFrame findFrame(String frameName)
frameName
- Name of frame to find. Non-null.IllegalArgumentException
- If frameName is null.public List<DlisType> getValues(String objectName, String attributeName)
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName
- Name of object to return value from. Non-null.attributeName
- Name of attribute to return. Non-null.IllegalArgumentException
- If objectName or attributeName is null.public DlisType getValue(String objectName, String attributeName)
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName
- Name of object to find value of. Non-null.attributeName
- Attribute to find value of. Non-null.IllegalArgumentException
- If objectName or attributeName is null.public DlisComponent getValueComponent(String objectName, String attributeName)
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName
- Name of object to find value component of. Non-null.attributeName
- Attribute to find value component of. Non-null.IllegalArgumentException
- If objectName or attributeName is null.public String getUnit(String objectName, String attributeName)
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName
- Name of object to return unit from. Non-null.attributeName
- Name of attribute to return. Non-null.IllegalArgumentException
- If objectName or attributeName is null.Copyright © 2024 Petroware AS - https://petroware.no