no.petroware.jwitsml

Class FunctionCapability

java.lang.Object

no.petroware.jwitsml.FunctionCapability

public final class FunctionCapability
extends Object

Model the object capabilities for a given WITSML function.

This is a property of the WITSML server and can be queried as follows:

    Capabilities serverCapabilities = witsmlServer.getServerCapabilities();

    // Loop over all supported WMLS functions and identify the WITSML
    // types supported for each
    for (FunctionCapability functionCapability : serverCapabilities.getFunctions()) {
      System.out.println("Function: " + functionCapability.getFunctionName())
      for (String witsmlType : functionCapability.getSupportedWitsmltypes()) {
        System.out.println("  Type: " + witsmlType);
      }
    }
 

Note that the client program does not provide function capabilities.

This class is thread-safe.

Author:

Petroware AS

Method Summary

Modifier and Type	Method and Description
String	getFunctionName() Return name of the function (such as "WMLS_GetFromStore" etc.)
Collection<String>	getSupportedWitsmlTypes() Return the WITSML types (such as "well", "wellbore", "log" etc.) supported by this function.
String	getVersion() Return WITSML version this capability is valid for.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getFunctionName

public String getFunctionName()

Return name of the function (such as "WMLS_GetFromStore" etc.)

Returns:

Name of the function. Never null.

getVersion

public String getVersion()

Return WITSML version this capability is valid for.

Returns:

WITSML version this capability is valid for. May be null.

getSupportedWitsmlTypes

public Collection<String> getSupportedWitsmlTypes()

Return the WITSML types (such as "well", "wellbore", "log" etc.) supported by this function.

Returns:

WITSML types supported by this function. Never null.

toString

public String toString()

Overrides:

toString in class Object