public abstract class WitsmlWell extends WitsmlObject
The well object is used to capture the general information about a well. This might sometimes be called a well header. All information which is the same for all wellbores (sidetracks) is contained in the well object.
Wells can be instantiated in two different ways in JWitsml client programs:
// Get wells from remote server List<WitsmlWell> wells = witsmlServer.get(WitsmlWell.class, new WitsmlQuery());
// Create instance WitsmlWell well = witsmlServer.newInstance(WitsmlWell.class, "my well", null); // Set properties well.setLicenseNumber("L-123"); well.setStatus(WitsmlWell.Status.ACTIVE); well.setWaterDepth(new Value(223.0, "m")); : // Add to remote server witsmlServer.add(well);
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlWell.Crs
WITSML - Well Coordinate Reference System Component Schema.
|
static class |
WitsmlWell.Datum
Defines the datums associated with elevation, vertical depth and
measured depth coordinates within the context of a well.
|
static class |
WitsmlWell.Fluid |
static class |
WitsmlWell.Purpose
These values represent the classification of a well or wellbore by
the purpose for which it was initially drilled.
|
static class |
WitsmlWell.ReferencePoint |
static class |
WitsmlWell.Status
These values represent the status of a well or wellbore.
|
static class |
WitsmlWell.WellDirection
The direction of flow of the fluids in a well facility (generally,
injected or produced, or some combination).
|
Modifier and Type | Method and Description |
---|---|
abstract WitsmlWell.Datum |
addDatum() |
abstract Location |
addLocation() |
abstract WitsmlWell.ReferencePoint |
addReferencePoint(String name) |
String |
getApiNumber()
Return the API number of this well.
|
String |
getBlock()
Return the block of this well.
|
String |
getCountry()
Return the country of this well.
|
String |
getCounty()
Return the county of this well.
|
String |
getDatum()
Return the datum of this well.
|
List<WitsmlWell.Datum> |
getDatums()
Return the datums of this well.
|
String |
getDistrict()
Return the district of this well.
|
String |
getField()
Return the field of this well.
|
WitsmlWell.Fluid |
getFluidType()
Return the fluid type of this well.
|
Value |
getGroundElevation()
Return the ground elevation of this well.
|
String |
getLegalName()
Return the legal name of this well.
|
Date |
getLicenseIssueTime()
Return the license issue time of this well.
|
String |
getLicenseNumber()
Return the license number of this well.
|
List<Location> |
getLocations()
Return the locations of this well.
|
String |
getOperator()
Return the operator of this well.
|
String |
getOperatorDivision()
Return the operator division of this well.
|
Value |
getOperatorInterestShare()
Return the operator interest share of this well.
|
Date |
getPluggedTime()
Return the plugged time of this well.
|
WitsmlWell.Purpose |
getPurpose()
Return the purpose of this well.
|
List<WitsmlWell.ReferencePoint> |
getReferencePoints()
Return the reference points of this well.
|
String |
getRegion()
Return the region of this well.
|
Date |
getSpudTime()
Return the spud time of this well.
|
String |
getState()
Return the state of this well.
|
WitsmlWell.Status |
getStatus()
Return the status of this well.
|
String |
getTimeZone()
Return the time zone of this well.
|
Value |
getWaterDepth()
Return the water depth of this well.
|
WitsmlWell.WellDirection |
getWellDirection()
Return the well direction of this well.
|
Value |
getWellHeadElevation()
Return the well head elevation of this well.
|
String |
getWellNumber()
Return the well number of this well.
|
void |
setApiNumber(String apiNumber)
Set the API number of this well.
|
void |
setBlock(String block)
Set the block of this well.
|
void |
setCountry(String country)
Set the country of this well.
|
void |
setCounty(String county)
Set the county of this well.
|
void |
setDatum(String datum)
Set the datum of this well.
|
void |
setDistrict(String district)
Set the district of this well.
|
void |
setField(String field)
Set the field of this well.
|
void |
setFluidType(WitsmlWell.Fluid fluidType)
Set the fluid type of this well.
|
void |
setGroundElevation(Value groundElevation)
Set the ground elevation of this well.
|
void |
setLegalName(String legalName)
Set the legal name of this well.
|
void |
setLicenseIssueTime(Date licenseIssueTime)
Set the license issue time of this well.
|
void |
setLicenseNumber(String licenseNumber)
Set the license number of this well.
|
void |
setOperator(String operator)
Set the operator of this well.
|
void |
setOperatorDivision(String operatorDivision)
Set the operator division of this well.
|
void |
setOperatorInterestShare(Value operatorInterestShare)
Set the operator interest share of this well.
|
void |
setPluggedTime(Date pluggedTime)
Set the plugged time of this well.
|
void |
setPurpose(WitsmlWell.Purpose purpose)
Set the purpose of this well.
|
void |
setRegion(String region)
Set the region of this well.
|
void |
setSpudTime(Date spudTime)
Set the spud time of this well.
|
void |
setState(String state)
Set the state of this well.
|
void |
setStatus(WitsmlWell.Status status)
Set the status of this well.
|
void |
setTimeZone(String timeZone)
Set the time zone of this well.
|
void |
setWaterDepth(Value waterDepth)
Set the water depth of this well.
|
void |
setWellDirection(WitsmlWell.WellDirection wellDirection)
Set the well direction of this well.
|
void |
setWellHeadElevation(Value wellHeadElevation)
Set the well head elevation of this well.
|
void |
setWellNumber(String wellNumber)
Set the well number of this well.
|
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 String getLegalName()
Corresponds to the WITSML property nameLegal
:
Legal name of the well.
public void setLegalName(String legalName)
Corresponds to the WITSML property nameLegal
:
Legal name of the well.
legalName
- The legal name to set.
May be null indicating absent or unknown.public String getLicenseNumber()
Corresponds to the WITSML property numLicense
:
License number of the well.
public void setLicenseNumber(String licenseNumber)
Corresponds to the WITSML property numLicense
:
License number of the well.
licenseNumber
- The license number to set.
May be null indicating absent or unknown.public Date getLicenseIssueTime()
Corresponds to the WITSML property dTimLicense
:
Date and time license was issued.
public void setLicenseIssueTime(Date licenseIssueTime)
Corresponds to the WITSML property dTimLicense
:
Date and time license was issued.
licenseIssueTime
- The license issue time to set.
May be null indicating absent or unknown.public String getField()
Corresponds to the WITSML property field
:
Name of the field in which the well is located.
public void setField(String field)
Corresponds to the WITSML property field
:
Name of the field in which the well is located.
field
- The field to set.
May be null indicating absent or unknown.public String getCountry()
Corresponds to the WITSML property country
:
Country in which well is located.
public void setCountry(String country)
Corresponds to the WITSML property country
:
Country in which well is located.
country
- The country to set.
May be null indicating absent or unknown.public String getWellNumber()
Corresponds to the WITSML property numGovt
:
Government assigned well number.
public void setWellNumber(String wellNumber)
Corresponds to the WITSML property numGovt
:
Government assigned well number.
wellNumber
- The well number to set.
May be null indicating absent or unknown.public String getState()
Corresponds to the WITSML property state
:
State or province in which well is located.
public void setState(String state)
Corresponds to the WITSML property state
:
State or province in which well is located.
state
- The state to set.
May be null indicating absent or unknown.public String getCounty()
Corresponds to the WITSML property county
:
County in which the well is located.
public void setCounty(String county)
Corresponds to the WITSML property county
:
County in which the well is located.
county
- The county to set.
May be null indicating absent or unknown.public String getRegion()
Corresponds to the WITSML property region
:
Geo-political region.
public void setRegion(String region)
Corresponds to the WITSML property region
:
Geo-political region.
region
- The region to set.
May be null indicating absent or unknown.public String getDistrict()
Corresponds to the WITSML property district
:
Geo-political district name.
public void setDistrict(String district)
Corresponds to the WITSML property district
:
Geo-political district name.
district
- The district to set.
May be null indicating absent or unknown.public String getBlock()
Corresponds to the WITSML property block
:
Block name in which well is located.
public void setBlock(String block)
Corresponds to the WITSML property block
:
Block name in which well is located.
block
- The block to set.
May be null indicating absent or unknown.public String getTimeZone()
Corresponds to the WITSML property timeZone
:
The time zone in which well is located. It is the deviation in hours and minutes from UTC. This should be the normal time zone at the well and not a seasonally adjusted value such as daylight savings time. While the time zone is optional in a date time value, it is strongly advised that the zone always be specified in each date time value. The time zone in a date time value may use seasonally adjusted values.
public void setTimeZone(String timeZone)
Corresponds to the WITSML property timeZone
:
The time zone in which well is located. It is the deviation in hours and minutes from UTC. This should be the normal time zone at the well and not a seasonally adjusted value such as daylight savings time. While the time zone is optional in a date time value, it is strongly advised that the zone always be specified in each date time value. The time zone in a date time value may use seasonally adjusted values.
timeZone
- The time zone to set.
May be null indicating absent or unknown.public String getOperator()
Corresponds to the WITSML property operator
:
Operator company name.
public void setOperator(String operator)
Corresponds to the WITSML property operator
:
Operator company name.
operator
- The operator to set.
May be null indicating absent or unknown.public String getOperatorDivision()
Corresponds to the WITSML property operatorDiv
:
Division of operator company.
public void setOperatorDivision(String operatorDivision)
Corresponds to the WITSML property operatorDiv
:
Division of operator company.
operatorDivision
- The operator division to set.
May be null indicating absent or unknown.public Value getOperatorInterestShare()
Corresponds to the WITSML property pcInterest
:
Interest for Operator. Commonly in percent.
public void setOperatorInterestShare(Value operatorInterestShare)
Corresponds to the WITSML property pcInterest
:
Interest for Operator. Commonly in percent.
operatorInterestShare
- The operator interest share to set.
May be null indicating absent or unknown.public String getApiNumber()
Corresponds to the WITSML property numAPI
:
American Petroleum Institute well number.
public void setApiNumber(String apiNumber)
Corresponds to the WITSML property numAPI
:
American Petroleum Institute well number.
apiNumber
- The API number to set.
May be null indicating absent or unknown.public WitsmlWell.Status getStatus()
Corresponds to the WITSML property statusWell
:
POSC Well status.
public void setStatus(WitsmlWell.Status status)
Corresponds to the WITSML property statusWell
:
POSC Well status.
status
- The status to set.
May be null indicating absent or unknown.public WitsmlWell.Purpose getPurpose()
Corresponds to the WITSML property purposeWell
:
POSC well purpose.
public void setPurpose(WitsmlWell.Purpose purpose)
Corresponds to the WITSML property purposeWell
:
POSC well purpose.
purpose
- The purpose to set.
May be null indicating absent or unknown.public WitsmlWell.Fluid getFluidType()
Corresponds to the WITSML property fluidWell, 1.3+
:
POSC well fluid. The type of fluid being produced from or injected into a well facility.
public void setFluidType(WitsmlWell.Fluid fluidType)
Corresponds to the WITSML property fluidWell, 1.3+
:
POSC well fluid. The type of fluid being produced from or injected into a well facility.
fluidType
- The fluid type to set.
May be null indicating absent or unknown.public WitsmlWell.WellDirection getWellDirection()
Corresponds to the WITSML property directionWell, 1.3+
:
POSC well direction. The direction of flow of the fluids in a well facility (generally, injected or produced, or some combination).
public void setWellDirection(WitsmlWell.WellDirection wellDirection)
Corresponds to the WITSML property directionWell, 1.3+
:
POSC well direction. The direction of flow of the fluids in a well facility (generally, injected or produced, or some combination).
wellDirection
- The well direction to set.
May be null indicating absent or unknown.public Date getSpudTime()
Corresponds to the WITSML property dTimSpud
:
Date and time at which well was spudded.
public void setSpudTime(Date spudTime)
Corresponds to the WITSML property dTimSpud
:
Date and time at which well was spudded.
spudTime
- The spud time to set.
May be null indicating absent or unknown.public Date getPluggedTime()
Corresponds to the WITSML property dTimPa
:
Date and time at which well was plugged and abandoned.
public void setPluggedTime(Date pluggedTime)
Corresponds to the WITSML property dTimPa
:
Date and time at which well was plugged and abandoned.
pluggedTime
- The plugged time to set.
May be null indicating absent or unknown.public Value getWellHeadElevation()
Corresponds to the WITSML property dtmPermToWellhead 1.2, wellheadElevation 1.3+
:
Elevation of wellhead relative to a wellDatum.
public void setWellHeadElevation(Value wellHeadElevation)
Corresponds to the WITSML property dtmPermToWellhead 1.2, wellheadElevation 1.3+
:
Elevation of wellhead relative to a wellDatum.
wellHeadElevation
- The well head elevation to set.
May be null indicating absent or unknown.public List<WitsmlWell.Datum> getDatums()
Corresponds to the WITSML property wellDatum
:
A datum to which elevations and depths are referenced.
public abstract WitsmlWell.Datum addDatum()
public String getDatum()
Corresponds to the WITSML property datum
:
public void setDatum(String datum)
Corresponds to the WITSML property datum
:
datum
- The datum to set.
May be null indicating absent or unknown.public Value getGroundElevation()
Corresponds to the WITSML property groundElevation
:
Elevation of ground level (land rigs).
public void setGroundElevation(Value groundElevation)
Corresponds to the WITSML property groundElevation
:
Elevation of ground level (land rigs).
groundElevation
- The ground elevation to set.
May be null indicating absent or unknown.public Value getWaterDepth()
Corresponds to the WITSML property waterDepth
:
*
public void setWaterDepth(Value waterDepth)
Corresponds to the WITSML property waterDepth
:
*
waterDepth
- The water depth to set.
May be null indicating absent or unknown.public List<Location> getLocations()
Corresponds to the WITSML property location 1.2, wellLocation 1.3+
:
The 2D coordinates of the well surface point in one coordinate reference system. This is where the well crosses ground level on land and crosses the platform offshore.
public abstract Location addLocation()
public List<WitsmlWell.ReferencePoint> getReferencePoints()
Corresponds to the WITSML property referencePoint
:
public abstract WitsmlWell.ReferencePoint addReferencePoint(String name)
Copyright © 2023 Petroware AS - https://petroware.no