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

Class TagSearchResult

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PROVIDER_NAME  

    • Constructor Summary

      Constructors 
      Constructor Description
      TagSearchResult​(TagPath tagPath, java.lang.String subPropId, Property<?> property, java.lang.Object propVal, boolean isMutable)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLocation()
      The name of the entity where this result is found.
      java.lang.String getName()
      The name of the object that matches the search pattern.
      Property<?> getProperty()  
      java.lang.String getSearchProviderName()
      The name of the search provider that created this result.
      java.lang.String getSubPropId()
      Uniquely identifies a property in a list of complex properties, such as alarms.
      TagPath getTagPath()
      The tag path without any properties
      java.lang.String getText()
      Gets the text representation of the search result.
      java.lang.Object getValue()  
      boolean isMutable()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TagSearchResult

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

    • Method Detail

      • getSearchProviderName

        public java.lang.String getSearchProviderName()
        Description copied from interface: SearchResult
        The name of the search provider that created this result.
        Specified by:
        getSearchProviderName in interface SearchResult

      • getLocation

        public java.lang.String getLocation()
        Description copied from interface: SearchResult
        The name of the entity where this result is found. Used in the results display to help distinguish similar items. For something like a tag property, the owner name is the path to the tag property
        Specified by:
        getLocation in interface SearchResult

      • getName

        public java.lang.String getName()
        Description copied from interface: SearchResult
        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.
        Specified by:
        getName in interface SearchResult

      • getText

        public java.lang.String getText()
        Description copied from interface: SearchResult
        Gets the text representation of the search result. This is what will be used for the "search".
        Specified by:
        getText in interface SearchResult

      • isMutable

        public boolean isMutable()
        Specified by:
        isMutable in interface SearchResult
        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 java.lang.Object getValue()

      • getSubPropId

        public java.lang.String getSubPropId()
        Uniquely identifies a property in a list of complex properties, such as alarms. Use "" for standard properties.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object