public abstract class WitsmlWellbore extends WitsmlObject
The wellbore object is used to capture the general information about a wellbore. This might sometimes be called a wellbore header. A wellbore represents the path from surface to a unique bottom hole. The wellbore object is uniquely identified within the context of one well object.
Wellbores can be instantiated in two different ways in JWitsml client programs:
// Get well wellbores from remote server List<WitsmlWellbore> wellbores = witsmlServer.get(WitsmlWellbore.class, new WitsmlQuery(), well);
// Create instance WitsmlWellbore wellbore = witsmlServer.newInstance(WitsmlWellbore.class, "my wellbore", well); // Set properties wellbore.setType(WitsmlWellbore.Type.SIDETRACK); wellbore.setActive(true); wellbore.setMdCurrent(new Value(1224.2, "m"); : // Add to remote server witsmlServer.add(wellbore);
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlWellbore.Shape
These values represent the classification of a wellbore based on
its shape.
|
static class |
WitsmlWellbore.Type
The classification of a wellbore with respect to its
parent well/wellbore.
|
Modifier and Type | Method and Description |
---|---|
String |
getApiSuffix()
Return the API suffix of this wellbore.
|
Date |
getKickoffTime()
Return the kickoff time of this wellbore.
|
Value |
getMdBitCurrent()
Return the MD bit current of this wellbore.
|
Value |
getMdCurrent()
Return the MD current of this wellbore.
|
Value |
getMdKickoff()
Return the MD kickoff of this wellbore.
|
Value |
getMdPlanned()
Return the MD planned of this wellbore.
|
Value |
getMdSubSeaPlanned()
Return the MD sub sea planned of this wellbore.
|
Value |
getNTargetDays()
Return the n target days of this wellbore.
|
String |
getNumber()
Return the number of this wellbore.
|
Reference |
getParentWellbore()
Return the parent wellbore of this wellbore.
|
WitsmlWell.Purpose |
getPurpose()
Return the purpose of this wellbore.
|
WitsmlWellbore.Shape |
getShape()
Return the shape of this wellbore.
|
WitsmlWell.Status |
getStatus()
Return the status of this wellbore.
|
Value |
getTvdBitCurrent()
Return the TVD bit current of this wellbore.
|
Value |
getTvdCurrent()
Return the TVD current of this wellbore.
|
Value |
getTvdKickoff()
Return the TVD kickoff of this wellbore.
|
Value |
getTvdPlanned()
Return the TVD planned of this wellbore.
|
Value |
getTvdSubSeaPlanned()
Return the TVD sub sea planned of this wellbore.
|
WitsmlWellbore.Type |
getType()
Return the type of this wellbore.
|
String |
getWellboreNumber()
Return the wellbore number of this wellbore.
|
String |
getWellName()
Return well name property of this wellbore.
|
Boolean |
isActive()
Return if this wellbore is active.
|
Boolean |
isTotalDepthReached()
Return if this wellbore is total depth reached.
|
void |
setActive(Boolean isActive)
Set if this wellbore is is active.
|
void |
setApiSuffix(String apiSuffix)
Set the API suffix of this wellbore.
|
void |
setKickoffTime(Date kickoffTime)
Set the kickoff time of this wellbore.
|
void |
setMdBitCurrent(Value mdBitCurrent)
Set the MD bit current of this wellbore.
|
void |
setMdCurrent(Value mdCurrent)
Set the MD current of this wellbore.
|
void |
setMdKickoff(Value mdKickoff)
Set the MD kickoff of this wellbore.
|
void |
setMdPlanned(Value mdPlanned)
Set the MD planned of this wellbore.
|
void |
setMdSubSeaPlanned(Value mdSubSeaPlanned)
Set the MD sub sea planned of this wellbore.
|
void |
setNTargetDays(Value nTargetDays)
Set the n target days of this wellbore.
|
void |
setNumber(String number)
Set the number of this wellbore.
|
void |
setParentWellbore(Reference parentWellbore)
Set the parent wellbore of this wellbore.
|
void |
setPurpose(WitsmlWell.Purpose purpose)
Set the purpose of this wellbore.
|
void |
setShape(WitsmlWellbore.Shape shape)
Set the shape of this wellbore.
|
void |
setStatus(WitsmlWell.Status status)
Set the status of this wellbore.
|
void |
setTotalDepthReached(Boolean isTotalDepthReached)
Set if this wellbore is is total depth reached.
|
void |
setTvdBitCurrent(Value tvdBitCurrent)
Set the TVD bit current of this wellbore.
|
void |
setTvdCurrent(Value tvdCurrent)
Set the TVD current of this wellbore.
|
void |
setTvdKickoff(Value tvdKickoff)
Set the TVD kickoff of this wellbore.
|
void |
setTvdPlanned(Value tvdPlanned)
Set the TVD planned of this wellbore.
|
void |
setTvdSubSeaPlanned(Value tvdSubSeaPlanned)
Set the TVD sub sea planned of this wellbore.
|
void |
setType(WitsmlWellbore.Type type)
Set the type of this wellbore.
|
void |
setWellboreNumber(String wellboreNumber)
Set the wellbore number of this wellbore.
|
void |
setWellName(String wellName)
Set well name property of this wellbore.
|
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 getParentWellbore()
Corresponds to the WITSML property parentWellbore
:
This is a pointer to the parent wellbore. No parent = starts from top.
public void setParentWellbore(Reference parentWellbore)
Corresponds to the WITSML property parentWellbore
:
This is a pointer to the parent wellbore. No parent = starts from top.
parentWellbore
- The parent wellbore to set.
May be null indicating absent or unknown.public String getWellName()
public void setWellName(String wellName)
wellName
- Well name to set.public String getNumber()
Corresponds to the WITSML property number
:
Operator borehole number.
public void setNumber(String number)
Corresponds to the WITSML property number
:
Operator borehole number.
number
- The number to set.
May be null indicating absent or unknown.public String getApiSuffix()
Corresponds to the WITSML property suffixAPI
:
API suffix.
public void setApiSuffix(String apiSuffix)
Corresponds to the WITSML property suffixAPI
:
API suffix.
apiSuffix
- The API suffix to set.
May be null indicating absent or unknown.public String getWellboreNumber()
Corresponds to the WITSML property numGovt
:
Government assigned number.
public void setWellboreNumber(String wellboreNumber)
Corresponds to the WITSML property numGovt
:
Government assigned number.
wellboreNumber
- The wellbore number to set.
May be null indicating absent or unknown.public WitsmlWell.Status getStatus()
Corresponds to the WITSML property statusWellbore
:
POSC wellbore status.
public void setStatus(WitsmlWell.Status status)
Corresponds to the WITSML property statusWellbore
:
POSC wellbore status.
status
- The status to set.
May be null indicating absent or unknown.public Boolean isActive()
Corresponds to the WITSML property isActive
:
True (="1" or "true") indicates that the wellbore is active. False (="0" or "false") indicates otherwise. It is the servers responsibility to set this value based on its available internal data (e.g., what objects are changing).
public void setActive(Boolean isActive)
Corresponds to the WITSML property isActive
:
True (="1" or "true") indicates that the wellbore is active. False (="0" or "false") indicates otherwise. It is the servers responsibility to set this value based on its available internal data (e.g., what objects are changing).
isActive
- The is active to set.
May be null indicating absent or unknown.public WitsmlWell.Purpose getPurpose()
Corresponds to the WITSML property purposeWellbore
:
POSC wellbore purpose.
public void setPurpose(WitsmlWell.Purpose purpose)
Corresponds to the WITSML property purposeWellbore
:
POSC wellbore purpose.
purpose
- The purpose to set.
May be null indicating absent or unknown.public WitsmlWellbore.Type getType()
Corresponds to the WITSML property typeWellbore
:
Type of wellbore.
public void setType(WitsmlWellbore.Type type)
Corresponds to the WITSML property typeWellbore
:
Type of wellbore.
type
- The type to set.
May be null indicating absent or unknown.public WitsmlWellbore.Shape getShape()
Corresponds to the WITSML property shape
:
POSC wellbore trajectory shape.
public void setShape(WitsmlWellbore.Shape shape)
Corresponds to the WITSML property shape
:
POSC wellbore trajectory shape.
shape
- The shape to set.
May be null indicating absent or unknown.public Date getKickoffTime()
Corresponds to the WITSML property dTimKickoff
:
Date and time of wellbore kickoff.
public void setKickoffTime(Date kickoffTime)
Corresponds to the WITSML property dTimKickoff
:
Date and time of wellbore kickoff.
kickoffTime
- The kickoff time to set.
May be null indicating absent or unknown.public Boolean isTotalDepthReached()
Corresponds to the WITSML property acheivedTD
:
True indicates that the wellbore has acheieved total depth. That is, drilling has completed. False indicates otherwise. Not given indicates that it is not known whether total depth has been reached.
public void setTotalDepthReached(Boolean isTotalDepthReached)
Corresponds to the WITSML property acheivedTD
:
True indicates that the wellbore has acheieved total depth. That is, drilling has completed. False indicates otherwise. Not given indicates that it is not known whether total depth has been reached.
isTotalDepthReached
- The is total depth reached to set.
May be null indicating absent or unknown.public Value getMdCurrent()
Corresponds to the WITSML property mdCurrent
:
The current measured depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging.
public void setMdCurrent(Value mdCurrent)
Corresponds to the WITSML property mdCurrent
:
The current measured depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging.
mdCurrent
- The MD current to set.
May be null indicating absent or unknown.public Value getTvdCurrent()
Corresponds to the WITSML property tvdCurrent
:
The current true vertical depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging.
public void setTvdCurrent(Value tvdCurrent)
Corresponds to the WITSML property tvdCurrent
:
The current true vertical depth of the borehole. If status is plugged, indicates the maximum depth reached before plugging.
tvdCurrent
- The TVD current to set.
May be null indicating absent or unknown.public Value getMdBitCurrent()
Corresponds to the WITSML property mdBitCurrent
:
The current measured depth of the bit. The server will populate this value at a time interval based on growing object criteria. The server should also populate the realtime stream with this same information in order to provide a time varying record of bit depth.
public void setMdBitCurrent(Value mdBitCurrent)
Corresponds to the WITSML property mdBitCurrent
:
The current measured depth of the bit. The server will populate this value at a time interval based on growing object criteria. The server should also populate the realtime stream with this same information in order to provide a time varying record of bit depth.
mdBitCurrent
- The MD bit current to set.
May be null indicating absent or unknown.public Value getTvdBitCurrent()
Corresponds to the WITSML property tvdBitCurrent
:
The current true vertical depth of the bit. The server will populate this value at a time interval based on growing object criteria. The server should also populate the realtime stream with this same information in order to provide a time varying record of bit depth.
public void setTvdBitCurrent(Value tvdBitCurrent)
Corresponds to the WITSML property tvdBitCurrent
:
The current true vertical depth of the bit. The server will populate this value at a time interval based on growing object criteria. The server should also populate the realtime stream with this same information in order to provide a time varying record of bit depth.
tvdBitCurrent
- The TVD bit current to set.
May be null indicating absent or unknown.public Value getMdKickoff()
Corresponds to the WITSML property mdKickoff
:
Kickoff measured depth of the wellbore.
public void setMdKickoff(Value mdKickoff)
Corresponds to the WITSML property mdKickoff
:
Kickoff measured depth of the wellbore.
mdKickoff
- The MD kickoff to set.
May be null indicating absent or unknown.public Value getTvdKickoff()
Corresponds to the WITSML property tvdKickoff
:
Kickoff true vertical depth of the wellbore.
public void setTvdKickoff(Value tvdKickoff)
Corresponds to the WITSML property tvdKickoff
:
Kickoff true vertical depth of the wellbore.
tvdKickoff
- The TVD kickoff to set.
May be null indicating absent or unknown.public Value getMdPlanned()
Corresponds to the WITSML property mdPlanned
:
Planned measured depth for the wellbore total depth.
public void setMdPlanned(Value mdPlanned)
Corresponds to the WITSML property mdPlanned
:
Planned measured depth for the wellbore total depth.
mdPlanned
- The MD planned to set.
May be null indicating absent or unknown.public Value getTvdPlanned()
Corresponds to the WITSML property tvdPlanned
:
Planned true vertical depth for the wellbore total depth.
public void setTvdPlanned(Value tvdPlanned)
Corresponds to the WITSML property tvdPlanned
:
Planned true vertical depth for the wellbore total depth.
tvdPlanned
- The TVD planned to set.
May be null indicating absent or unknown.public Value getMdSubSeaPlanned()
Corresponds to the WITSML property mdSubSeaPlanned
:
Planned measured for the wellbore total depth - with respect to seabed.
public void setMdSubSeaPlanned(Value mdSubSeaPlanned)
Corresponds to the WITSML property mdSubSeaPlanned
:
Planned measured for the wellbore total depth - with respect to seabed.
mdSubSeaPlanned
- The MD sub sea planned to set.
May be null indicating absent or unknown.public Value getTvdSubSeaPlanned()
Corresponds to the WITSML property tvdSubSeaPlanned
:
Planned true vertical depth for the wellbore total depth - with respect to seabed.
public void setTvdSubSeaPlanned(Value tvdSubSeaPlanned)
Corresponds to the WITSML property tvdSubSeaPlanned
:
Planned true vertical depth for the wellbore total depth - with respect to seabed.
tvdSubSeaPlanned
- The TVD sub sea planned to set.
May be null indicating absent or unknown.public Value getNTargetDays()
Corresponds to the WITSML property dayTarget
:
Target days for drilling wellbore.
public void setNTargetDays(Value nTargetDays)
Corresponds to the WITSML property dayTarget
:
Target days for drilling wellbore.
nTargetDays
- The n target days to set.
May be null indicating absent or unknown.Copyright © 2023 Petroware AS - https://petroware.no