com.sitewhere.spi.device.symbology

Interface ISymbolGenerator

All Superinterfaces:

ILifecycleComponent, ITenantLifecycleComponent

public interface ISymbolGenerator
extends ITenantLifecycleComponent

Generates symbols which uniquely identify SiteWhere entities.

Method Summary

Modifier and Type	Method and Description
byte[]	getDeviceAssigmentSymbol(IDeviceAssignment assignment, IEntityUriProvider provider) Get symbol for a device assignment.
byte[]	getDeviceSpecificationSymbol(IDeviceSpecification specification, IEntityUriProvider provider) Get symbol for a device specification.
byte[]	getDeviceSymbol(IDevice device, IEntityUriProvider provider) Get symbol for a device.
java.lang.String	getId() Get unique generator id.
java.lang.String	getName() Get name of symbol generator.
byte[]	getSiteSymbol(ISite site, IEntityUriProvider provider) Get symbol for a site.

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ITenantLifecycleComponent

getTenant, setTenant

Methods inherited from interface com.sitewhere.spi.server.lifecycle.ILifecycleComponent

canPause, findComponentsOfType, getComponentId, getComponentName, getComponentType, getCreatedDate, getLifecycleComponents, getLifecycleError, getLifecycleStatus, getLogger, initialize, initializeNestedComponent, lifecycleInitialize, lifecyclePause, lifecycleStart, lifecycleStop, lifecycleStop, logState, pause, start, startNestedComponent, stop, stop

Method Detail

getId

java.lang.String getId()
                throws SiteWhereException

Get unique generator id.

Returns:

Throws:

SiteWhereException

getName

java.lang.String getName()
                  throws SiteWhereException

Get name of symbol generator.

Returns:

Throws:

SiteWhereException

getSiteSymbol

byte[] getSiteSymbol(ISite site,
                     IEntityUriProvider provider)
              throws SiteWhereException

Get symbol for a site.

Parameters:

site -

provider -

Returns:

Throws:

SiteWhereException

getDeviceSpecificationSymbol

byte[] getDeviceSpecificationSymbol(IDeviceSpecification specification,
                                    IEntityUriProvider provider)
                             throws SiteWhereException

Get symbol for a device specification.

Parameters:

specification -

provider -

Returns:

Throws:

SiteWhereException

getDeviceSymbol

byte[] getDeviceSymbol(IDevice device,
                       IEntityUriProvider provider)
                throws SiteWhereException

Get symbol for a device.

Parameters:

device -

provider -

Returns:

Throws:

SiteWhereException

getDeviceAssigmentSymbol

byte[] getDeviceAssigmentSymbol(IDeviceAssignment assignment,
                                IEntityUriProvider provider)
                         throws SiteWhereException

Get symbol for a device assignment.

Parameters:

assignment -

provider -

Returns:

Throws:

SiteWhereException