Package com.inductiveautomation.ignition.common.tags.search

Class TagSearchResult

java.lang.Object

com.inductiveautomation.ignition.common.tags.search.TagSearchResult

All Implemented Interfaces:

Serializable

public class TagSearchResult
extends Object
implements Serializable

Since:

8.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TagSearchResult(TagPath tagPath, String subPropId, Property<?> property, Object propVal, boolean isMutable)

Method Summary

Modifier and Type	Method	Description
String	getName()	The name of the object that matches the search pattern.
Property<?>	getProperty()
String	getSubPropId()	Uniquely identifies a property in a list of complex properties, such as alarms.
TagPath	getTagPath()	The tag path without any properties
String	getText()	Gets the text representation of the search result.
Object	getValue()
boolean	isMutable()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TagSearchResult

public TagSearchResult(TagPath tagPath,
 String subPropId,
 Property<?> property,
 Object propVal,
 boolean isMutable)

Method Details

getName

public String getName()

The name of the object that matches the search pattern. In other words, a description of the element inside the owner, such as "Name", or "Expression". For something like a tag, the name is the tag property where the search pattern was found.

getText

public String getText()

Gets the text representation of the search result. This is what will be used for the "search".

isMutable

public boolean isMutable()

Returns:

true if the returned item can be modified via a replace operation

getTagPath

public TagPath getTagPath()

The tag path without any properties

getProperty

public Property<?> getProperty()

getValue

public Object getValue()

getSubPropId

public String getSubPropId()

Uniquely identifies a property in a list of complex properties, such as alarms. Use "" for standard properties.

toString

public String toString()

Overrides:

toString in class Object