Package com.inductiveautomation.ignition.common.sqltags

Class TagProviderMetaImpl

java.lang.Object

com.inductiveautomation.ignition.common.sqltags.TagProviderMetaImpl

All Implemented Interfaces:

TagProviderMeta, Serializable

public class TagProviderMetaImpl
extends Object
implements Serializable, TagProviderMeta

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.sqltags.model.TagProviderMeta

FLAG_HAS_DRIVERS, FLAG_HAS_OPCBROWSE, FLAG_HAS_SCANCLASSES, FLAG_IS_DATABASE, FLAG_IS_DEFAULT, FLAG_IS_INTERNAL, FLAG_IS_RUNTIME_STATUS, FLAG_IS_SYSTEM, FLAG_PROVIDES_COMPLEX_TYPES, FLAG_SUPPORTS_HISTORY

Constructor Summary

Constructors

Constructor	Description
TagProviderMetaImpl(String name, String desc)
TagProviderMetaImpl(String name, String desc, Collection<TagMeta> acceptedTypes)	Creates a new TagProviderMeta
TagProviderMetaImpl(String name, String desc, Collection<TagMeta> acceptedTypes, Flags flags)

Method Summary

Modifier and Type	Method	Description
boolean	canAcceptTag(ExtendedTagType type)
TagProviderMetaImpl	clearFlag(int flag)
TagProviderMeta	combine(TagProviderMeta other)
Collection<TagMeta>	getCreatableTagTypes()	Returns the tag metas of tag types that can be added to the provider.
String	getDescription()
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()
String	getName()	The name of the provider, as it will be used in tag paths.
TagMeta	getTagMeta(ExtendedTagType type)
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()
protected String	keyFor(TagType type, String subType)
void	registerTypeType(TagMeta meta)
void	setDisplayPath(String value)
TagProviderMetaImpl	setFlag(int flag)
void	setFlag(int flag, boolean b)
TagProviderMetaImpl	setFlags(int... flags)
boolean	supportsEditRoles()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TagProviderMetaImpl

public TagProviderMetaImpl(String name,
 String desc)

TagProviderMetaImpl

public TagProviderMetaImpl(String name,
 String desc,
 Collection<TagMeta> acceptedTypes)

Creates a new TagProviderMeta

Parameters:

name - The name of this provider. This name is the "source" element of all tag paths in this provider. If the name contains "/", it will be used as the display path, and the last portion will be used for the name.

TagProviderMetaImpl

public TagProviderMetaImpl(String name,
 String desc,
 Collection<TagMeta> acceptedTypes,
 Flags flags)

Method Details

getName

public String getName()

Description copied from interface: TagProviderMeta

The name of the provider, as it will be used in tag paths. Must not contain illegal characters like '/'.

Specified by:

getName in interface TagProviderMeta

getDisplayPath

public String getDisplayPath()

Description copied from interface: TagProviderMeta

Generally equal to the name, the display path can contain forward-slash ("/") separated components to create a folder hierarchy in the display.

Specified by:

getDisplayPath in interface TagProviderMeta

setDisplayPath

public void setDisplayPath(String value)

getDescription

public String getDescription()

Specified by:

getDescription in interface TagProviderMeta

isFlagSet

public boolean isFlagSet(int flag)

Specified by:

isFlagSet in interface TagProviderMeta

setFlag

public void setFlag(int flag,
 boolean b)

setFlag

public TagProviderMetaImpl setFlag(int flag)

setFlags

public TagProviderMetaImpl setFlags(int... flags)

clearFlag

public TagProviderMetaImpl clearFlag(int flag)

getFlags

public Flags getFlags()

Specified by:

getFlags in interface TagProviderMeta

isSystem

public boolean isSystem()

Specified by:

isSystem in interface TagProviderMeta

supportsEditRoles

public boolean supportsEditRoles()

Specified by:

supportsEditRoles in interface TagProviderMeta

hasSubDrivers

public boolean hasSubDrivers()

Description copied from interface: TagProviderMeta

Whether the provider supports multiple drivers. Example: the legacy provider, which can have any number of FSQLs driving it.

Specified by:

hasSubDrivers in interface TagProviderMeta

hasScanClasses

public boolean hasScanClasses()

Description copied from interface: TagProviderMeta

Whether or not this provider has ScanClasses. Some providers, built-in ones for example, may not support scan classes

Specified by:

hasScanClasses in interface TagProviderMeta

toString

public String toString()

Overrides:

toString in class Object

keyFor

protected String keyFor(TagType type,
 String subType)

getTagMeta

public TagMeta getTagMeta(ExtendedTagType type)

Specified by:

getTagMeta in interface TagProviderMeta

canAcceptTag

public boolean canAcceptTag(ExtendedTagType type)

Specified by:

canAcceptTag in interface TagProviderMeta

registerTypeType

public void registerTypeType(TagMeta meta)

getCreatableTagTypes

public Collection<TagMeta> getCreatableTagTypes()

Description copied from interface: TagProviderMeta

Returns the tag metas of tag types that can be added to the provider. If empty, the provider does not support new tags.

Specified by:

getCreatableTagTypes in interface TagProviderMeta

getTagTypes

public Collection<TagMeta> getTagTypes()

Description copied from interface: TagProviderMeta

Returns all tag types that might be present in this provider.

Specified by:

getTagTypes in interface TagProviderMeta

intersect

public TagProviderMeta intersect(TagProviderMeta other)

Description copied from interface: TagProviderMeta

Creates an intersection between tag provider metas. The returned meta will represent multiple providers, and will contain the common tag types and provider flags.

Specified by:

intersect in interface TagProviderMeta

combine

public TagProviderMeta combine(TagProviderMeta other)

Specified by:

combine in interface TagProviderMeta