com.splunk
Class PivotFilter

java.lang.Object
  com.splunk.PivotFilter

Direct Known Subclasses:

BooleanPivotFilter, IPv4PivotFilter, LimitPivotFilter, NumberPivotFilter, StringPivotFilter

public abstract class PivotFilter
extends java.lang.Object

Base class representing filters in pivots.

Field Summary

protected DataModelObject	dataModelObject
protected java.lang.String	fieldName

Method Summary

protected void	addCommonFields(com.google.gson.JsonObject root) Called by subclasses to add the fields common to all subclasses to JSON serializations.
java.lang.String	getFieldName()
java.lang.String[]	getOwnerLineage()
java.lang.String	getOwnerName()
FieldType	getType()

Methods inherited from class java.lang.Object

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

Field Detail

dataModelObject

protected final DataModelObject dataModelObject

fieldName

protected final java.lang.String fieldName

Method Detail

getOwnerName

public java.lang.String getOwnerName()

Returns:

the name of the data model object this filter's field is defined on.

getOwnerLineage

public java.lang.String[] getOwnerLineage()

Returns:

return the lineage, most remote ancestor first, of the data model object his filter's field is defined on.

getFieldName

public java.lang.String getFieldName()

Returns:

the name of the field to filter on.

getType

public FieldType getType()

Returns:

the type of the field we are filtering on.

addCommonFields

protected void addCommonFields(com.google.gson.JsonObject root)

Called by subclasses to add the fields common to all subclasses to JSON serializations.

Parameters:

root - a JsonObject instance representing a serialization of this object.