Interface TagProviderMeta
-
- All Known Implementing Classes:
TagProviderMetaImpl
public interface TagProviderMeta
-
-
Field Summary
Fields Modifier and Type Field Description static int
FLAG_HAS_DRIVERS
static int
FLAG_HAS_OPCBROWSE
Indicates that the provider supports opc browsing.static int
FLAG_HAS_SCANCLASSES
static int
FLAG_IS_DATABASE
static int
FLAG_IS_DEFAULT
static int
FLAG_IS_INTERNAL
Indicates that the provider is an Internal provider.static int
FLAG_IS_RUNTIME_STATUS
This flag indicates that the provider is a "status" system, which has the following implications:
1) Cannot be used for project's default provider.
2) Does not appear on the SQLTags status page.static int
FLAG_IS_SYSTEM
A flag that indicates if this provider is a "system" provider, which means that it is always displayed in the top level of the SQLTags browser and not hidden away in the "All Providers" node.static int
FLAG_PROVIDES_COMPLEX_TYPES
static int
FLAG_SUPPORTS_HISTORY
Indicates that the tags in this provider should be queried for history THROUGH the provider, not directly against their history provider.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
canAcceptTag(ExtendedTagType type)
TagProviderMeta
combine(TagProviderMeta other)
java.util.Collection<TagMeta>
getCreatableTagTypes()
Returns the tag metas of tag types that can be added to the provider.java.lang.String
getDescription()
java.lang.String
getDisplayPath()
Generally equal to the name, the display path can contain forward-slash ("/") separated components to create a folder hierarchy in the display.Flags
getFlags()
java.lang.String
getName()
The name of the provider, as it will be used in tag paths.TagMeta
getTagMeta(ExtendedTagType type)
java.util.Collection<TagMeta>
getTagTypes()
Returns all tag types that might be present in this provider.boolean
hasScanClasses()
Whether or not this provider has ScanClasses.boolean
hasSubDrivers()
Whether the provider supports multiple drivers.TagProviderMeta
intersect(TagProviderMeta other)
Creates an intersection between tag provider metas.boolean
isFlagSet(int flag)
boolean
isSystem()
boolean
supportsEditRoles()
-
-
-
Field Detail
-
FLAG_HAS_SCANCLASSES
static final int FLAG_HAS_SCANCLASSES
- See Also:
- Constant Field Values
-
FLAG_HAS_DRIVERS
static final int FLAG_HAS_DRIVERS
- See Also:
- Constant Field Values
-
FLAG_HAS_OPCBROWSE
static final int FLAG_HAS_OPCBROWSE
Indicates that the provider supports opc browsing. If not, it won't show up in the list of providers in the OPC browse window.- See Also:
- Constant Field Values
-
FLAG_IS_SYSTEM
static final int FLAG_IS_SYSTEM
A flag that indicates if this provider is a "system" provider, which means that it is always displayed in the top level of the SQLTags browser and not hidden away in the "All Providers" node.- See Also:
- Constant Field Values
-
FLAG_IS_DEFAULT
static final int FLAG_IS_DEFAULT
- See Also:
- Constant Field Values
-
FLAG_IS_DATABASE
static final int FLAG_IS_DATABASE
- See Also:
- Constant Field Values
-
FLAG_IS_INTERNAL
static final int FLAG_IS_INTERNAL
Indicates that the provider is an Internal provider. Also implies that it is a provider which does ALL of its execution locally (allowing access to things like local data connections, for example)- See Also:
- Constant Field Values
-
FLAG_SUPPORTS_HISTORY
static final int FLAG_SUPPORTS_HISTORY
Indicates that the tags in this provider should be queried for history THROUGH the provider, not directly against their history provider.- See Also:
- Constant Field Values
-
FLAG_IS_RUNTIME_STATUS
static final int FLAG_IS_RUNTIME_STATUS
This flag indicates that the provider is a "status" system, which has the following implications:
1) Cannot be used for project's default provider.
2) Does not appear on the SQLTags status page.- See Also:
- Constant Field Values
-
FLAG_PROVIDES_COMPLEX_TYPES
static final int FLAG_PROVIDES_COMPLEX_TYPES
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
The name of the provider, as it will be used in tag paths. Must not contain illegal characters like '/'.
-
getDisplayPath
java.lang.String getDisplayPath()
Generally equal to the name, the display path can contain forward-slash ("/") separated components to create a folder hierarchy in the display.
-
getDescription
java.lang.String getDescription()
-
isSystem
boolean isSystem()
-
supportsEditRoles
boolean supportsEditRoles()
-
hasSubDrivers
boolean hasSubDrivers()
Whether the provider supports multiple drivers. Example: the legacy provider, which can have any number of FSQLs driving it.
-
getCreatableTagTypes
java.util.Collection<TagMeta> getCreatableTagTypes()
Returns the tag metas of tag types that can be added to the provider. If empty, the provider does not support new tags.
-
getTagTypes
java.util.Collection<TagMeta> getTagTypes()
Returns all tag types that might be present in this provider.
-
canAcceptTag
boolean canAcceptTag(ExtendedTagType type)
-
hasScanClasses
boolean hasScanClasses()
Whether or not this provider has ScanClasses. Some providers, built-in ones for example, may not support scan classes
-
isFlagSet
boolean isFlagSet(int flag)
-
getFlags
Flags getFlags()
-
getTagMeta
TagMeta getTagMeta(ExtendedTagType type)
-
intersect
TagProviderMeta intersect(TagProviderMeta other)
Creates an intersection between tag provider metas. The returned meta will represent multiple providers, and will contain the common tag types and provider flags.
-
combine
TagProviderMeta combine(TagProviderMeta other)
-
-