public abstract class WitsmlAttachment extends WitsmlObject
The attachment object is used to provide a central location for finding a digital attachment that is associated with another WITSML well related object. The attachment is captured in a base 64 binary type.
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlAttachment.Parameter |
Modifier and Type | Method and Description |
---|---|
abstract WitsmlAttachment.Parameter |
addParameter() |
String |
getContent()
Return the content of this attachment.
|
String |
getDescription()
Return the description of this attachment.
|
String |
getFileName()
Return the file name associated with this attachment.
|
String |
getFileType()
Return file type of the file associated with this attachment.
|
Value |
getMd()
Return the MD of this attachment.
|
Value |
getMdBit()
Return the MD of the bit associated with this attachment.
|
Reference |
getObjectReference()
Return the object reference of this attachment.
|
List<WitsmlAttachment.Parameter> |
getParameters() |
Reference |
getSubObjectReference()
Return the sub-object reference of this attachment.
|
void |
setAttachment(File file)
Specify a specific file as attachment.
|
void |
setContent(String content)
Set the content of this attachment.
|
void |
setDescription(String description)
Set the description of this attachment.
|
void |
setFileName(String fileName)
Set the file name associated with this attachment.
|
void |
setFileType(String fileType)
Set file type of the file associated with this attachment.
|
void |
setMd(Value md)
Set MD of this attachment.
|
void |
setMdBit(Value mdBit)
Set the MD bit of this attachment.
|
void |
setObjectReference(Reference objectReference)
Set the object reference of this attachment.
|
void |
setSubObjectReference(Reference subObjectReference)
Set the sub-object reference of this attachment.
|
equals, getAddQuery, getAliases, getCitation, getCommonData, getEtpResource, getEtpServer, getId, getName, getParent, getParentId, getReadLock, getServer, getVersion, getWitsmlServer, getWitsmlType, getWriteLock, hashCode, newAliases, newCitation, newCommonData, setEtpResource, setName, toString
public Reference getObjectReference()
Corresponds to the WITSML property objectReference
:
A reference to an object that is defined within the context
of the specified wellbore.
public void setObjectReference(Reference objectReference)
Corresponds to the WITSML property objectReference
:
A reference to an object that is defined within the context
of the specified wellbore.
objectReference
- The object reference to set.public Reference getSubObjectReference()
Corresponds to the WITSML property subObjectReference
:
A reference to an sub-object that is defined within the context of the
object referenced by objectReference. This should only refer to recurring
components of a growing object.
public void setSubObjectReference(Reference subObjectReference)
Corresponds to the WITSML property subObjectReference
:
A reference to an sub-object that is defined within the context of the
object referenced by objectReference. This should only refer to recurring
components of a growing object.
subObjectReference
- The sub-object reference to set.public Value getMd()
Corresponds to the WITSML property md
:
Along hole measured depth represented by the attachment.
public void setMd(Value md)
Corresponds to the WITSML property md
:
Along hole measured depth represented by the attachment.
md
- MD to set.public Value getMdBit()
Corresponds to the WITSML property mdBit
:
Along hole measured depth of the bit.
public void setMdBit(Value mdBit)
Corresponds to the WITSML property mdBit
:
Along hole measured depth of the bit.
mdBit
- The MD bit to set.public List<WitsmlAttachment.Parameter> getParameters()
public abstract WitsmlAttachment.Parameter addParameter()
public String getFileName()
Corresponds to the WITSML property fileName
:
A file name associated with the attachment.
public void setFileName(String fileName)
Corresponds to the WITSML property fileName
:
A file name associated with the attachment.
fileName
- File name to set.public String getDescription()
Corresponds to the WITSML property description
:
A description of the attachment.
public void setDescription(String description)
Corresponds to the WITSML property description
:
A description of the attachment.
description
- Description to set.public String getFileType()
Corresponds to the WITSML property fileType
:
The file type.
public void setFileType(String fileType)
Corresponds to the WITSML property fileType
:
The file type.
fileType
- File type to set.public String getContent()
Corresponds to the WITSML property content
:
The actual attachment content.
public void setContent(String content)
Corresponds to the WITSML property content
:
The actual attachment content.
content
- The content to set.public void setAttachment(File file) throws IOException
file
- File to make as attachment. Non-null.IllegalArgumentException
- If file is null.IOException
- If the file cannot be read.Copyright © 2023 Petroware AS - https://petroware.no