Package com.inductiveautomation.ignition.common

Class DocumentIndex

java.lang.Object

com.inductiveautomation.ignition.common.DocumentIndex

All Implemented Interfaces:

SubIndex, Serializable

public class DocumentIndex
extends Object
implements SubIndex

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentIndex(JsonPath path)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
protected Object	extractValue(DocumentElement element)
QualifiedValue	extractValue(Object source)	Pulls the value out of a qualified value.
JsonPath	getPath()
int	hashCode()
boolean	isCompatible(Class<?> dataClazz)	Returns whether this sub index can be used with the incoming value type.
static boolean	isDocumentIndex(String value)
static DocumentIndex	parse(String value)	A very simple parse mechanism.
String	toEncodedString()	Returns the index in a way that can be appended to a path.
String	toString()
QualityCode	updateValue(Object sourceValue, Object elementValue)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DocumentIndex

public DocumentIndex(JsonPath path)

Method Details

isDocumentIndex

public static boolean isDocumentIndex(String value)

getPath

public JsonPath getPath()

parse

public static DocumentIndex parse(String value)

A very simple parse mechanism. Allows: "[x]", "[x,y]", "x", "x,y"

isCompatible

public boolean isCompatible(Class<?> dataClazz)

Description copied from interface: SubIndex

Returns whether this sub index can be used with the incoming value type.

Specified by:

isCompatible in interface SubIndex

extractValue

public QualifiedValue extractValue(Object source)

Description copied from interface: SubIndex

Pulls the value out of a qualified value. The resulting value will have the same timestamp and quality as the source, unless a new quality is generated as a result of trying to extract the. Returns any errors as quality on the value.

Specified by:

extractValue in interface SubIndex

updateValue

public QualityCode updateValue(Object sourceValue,
 Object elementValue)

Specified by:

updateValue in interface SubIndex

extractValue

protected Object extractValue(DocumentElement element)
                       throws IllegalStateException

Throws:

IllegalStateException

toEncodedString

public String toEncodedString()

Description copied from interface: SubIndex

Returns the index in a way that can be appended to a path. Should return a value that can be read by a static parse function on the implementation.

Specified by:

toEncodedString in interface SubIndex

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object