etri.sdn.controller.module.devicemanager

Class EntityToSingleDeviceIdIndex

java.lang.Object

etri.sdn.controller.module.devicemanager.DeviceIndex

etri.sdn.controller.module.devicemanager.EntityToSingleDeviceIdIndex

public class EntityToSingleDeviceIdIndex
extends DeviceIndex

An index that maps key fields of an entity uniquely to a device key

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.ConcurrentHashMap<IndexedEntity,java.lang.Long>	index The index

Fields inherited from class etri.sdn.controller.module.devicemanager.DeviceIndex

keyFields

Constructor Summary

Constructors

Constructor and Description
EntityToSingleDeviceIdIndex(java.util.EnumSet<IDeviceService.DeviceField> keyFields) Construct a new device index using the provided key fields.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	findByEntity(Entity entity) Look up a Device based on the provided Entity.
java.util.Iterator<java.lang.Long>	getAll() Gets all device keys in the index.
java.util.Iterator<java.lang.Long>	queryByEntity(Entity entity) Finds all device keys in the index that match the given entity on all the key fields for this index.
void	removeEntity(Entity entity) Removes the entry for the given entity.
void	removeEntity(Entity entity, java.lang.Long deviceKey) Removes the given device key from the index for the given entity.
boolean	updateIndex(Device device, java.lang.Long deviceKey) Attempts to update an index with the entities in the provided Device.
void	updateIndex(Entity entity, java.lang.Long deviceKey) Adds a mapping from the given entity to the given device key.

Methods inherited from class etri.sdn.controller.module.devicemanager.DeviceIndex

removeEntityIfNeeded

Methods inherited from class java.lang.Object

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

Field Detail

index

private java.util.concurrent.ConcurrentHashMap<IndexedEntity,java.lang.Long> index

The index

Constructor Detail

EntityToSingleDeviceIdIndex

public EntityToSingleDeviceIdIndex(java.util.EnumSet<IDeviceService.DeviceField> keyFields)

Construct a new device index using the provided key fields.

Parameters:

keyFields - the key fields to use

Method Detail

queryByEntity

public java.util.Iterator<java.lang.Long> queryByEntity(Entity entity)

Description copied from class: DeviceIndex

Finds all device keys in the index that match the given entity on all the key fields for this index.

Specified by:

queryByEntity in class DeviceIndex

Parameters:

entity - the entity to search for

Returns:

an iterator over device keys

getAll

public java.util.Iterator<java.lang.Long> getAll()

Description copied from class: DeviceIndex

Gets all device keys in the index. If certain devices exist multiple times, then these devices may be returned multiple times.

Specified by:

getAll in class DeviceIndex

Returns:

an iterator over device keys

updateIndex

public boolean updateIndex(Device device,
                  java.lang.Long deviceKey)

Description copied from class: DeviceIndex

Attempts to update an index with the entities in the provided Device. If the update fails because of a concurrent update, will return false.

Specified by:

updateIndex in class DeviceIndex

Parameters:

device - the device to update

deviceKey - the device key for the device

Returns:

true if the update succeeded, false otherwise.

updateIndex

public void updateIndex(Entity entity,
               java.lang.Long deviceKey)

Description copied from class: DeviceIndex

Adds a mapping from the given entity to the given device key. This update will not fail because of a concurrent update.

Specified by:

updateIndex in class DeviceIndex

Parameters:

entity - the entity to update

deviceKey - the device key for the device

removeEntity

public void removeEntity(Entity entity)

Description copied from class: DeviceIndex

Removes the entry for the given entity.

Specified by:

removeEntity in class DeviceIndex

Parameters:

entity - the entity to remove

removeEntity

public void removeEntity(Entity entity,
                java.lang.Long deviceKey)

Description copied from class: DeviceIndex

Removes the given device key from the index for the given entity.

Specified by:

removeEntity in class DeviceIndex

Parameters:

entity - the entity to search for

deviceKey - the key to remove

findByEntity

public java.lang.Long findByEntity(Entity entity)

Look up a Device based on the provided Entity.

Parameters:

entity - the entity to search for

Returns:

the key for the Device object if found