com.splunk

Class DataModelCalculation

java.lang.Object

com.splunk.DataModelCalculation

Direct Known Subclasses:

EvalDataModelCalculation, GeoIPDataModelCalculation, LookupDataModelCalculation, RegexpDataModelCalculation

public abstract class DataModelCalculation
extends java.lang.Object

Abstract class specifying a calculation on a data model object.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataModelCalculation(java.lang.String[] ownerLineage, java.lang.String calculationID, java.util.Map<java.lang.String,DataModelField> generatedFields, java.lang.String comment, boolean editable)

Method Summary

Modifier and Type	Method and Description
boolean	containsGeneratedField(java.lang.String fieldName)
java.lang.String	getCalculationID()
java.lang.String	getComment()
DataModelField	getGeneratedField(java.lang.String fieldName)
java.util.Collection<DataModelField>	getGeneratedFields()
java.lang.String[]	getLineage() Return the lineage of the data model object on which this calculation is defined, starting with the most remote ancestor and ending with the data model object on which this calculation is defined.
java.lang.String	getOwner() Returns the name of the object on which this calculation is defined.
boolean	isEditable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataModelCalculation

protected DataModelCalculation(java.lang.String[] ownerLineage,
                               java.lang.String calculationID,
                               java.util.Map<java.lang.String,DataModelField> generatedFields,
                               java.lang.String comment,
                               boolean editable)

Method Detail

getCalculationID

public java.lang.String getCalculationID()

Returns:

the ID of this calculation.

containsGeneratedField

public boolean containsGeneratedField(java.lang.String fieldName)

Parameters:

fieldName - Name of the field to fetch.

Returns:

whether this calculation generated a field of the given name.

getGeneratedFields

public java.util.Collection<DataModelField> getGeneratedFields()

Returns:

a collection of the fields this calculation generates.

getGeneratedField

public DataModelField getGeneratedField(java.lang.String fieldName)

Parameters:

fieldName - Name of the field to fetch.

Returns:

a DataModelField object.

getComment

public java.lang.String getComment()

Returns:

the comment on this calculation (if one is specified) or null.

getOwner

public java.lang.String getOwner()

Returns the name of the object on which this calculation is defined. That need not be the one you accessed it from, as it may be inherited from another data model object.

Returns:

The name of the object on which this calculation is defined.

getLineage

public java.lang.String[] getLineage()

Return the lineage of the data model object on which this calculation is defined, starting with the most remote ancestor and ending with the data model object on which this calculation is defined.

Returns:

an array of the names of data model objects.

isEditable

public boolean isEditable()

Returns:

whether this calculation can be edited, or it is a system defined calculation.