net.floodlightcontroller.devicemanager
Interface IEntityClass

All Known Implementing Classes:

DefaultEntityClassifier.DefaultEntityClass

public interface IEntityClass

Entities within an entity class are grouped into Device objects based on the IEntityClass, and the key fields specified by the entity class. A set of entities are considered to be the same device if and only if they belong to the same entity class and they match on all key fields for that entity class. A field is effectively wildcarded by not including it in the list of key fields returned by IEntityClassifierService and/or IEntityClass. Note that if you're not using static objects, you'll need to override Object.equals(Object) and Object.hashCode().

Author:

readams

Method Summary

java.util.EnumSet<IDeviceService.DeviceField>	getKeyFields() Return the set of key fields for this entity class.
java.lang.String	getName() Returns a user-friendly, unique name for this EntityClass

Method Detail

getKeyFields

java.util.EnumSet<IDeviceService.DeviceField> getKeyFields()

Return the set of key fields for this entity class. Entities belonging to this class that differ in fields not included in this collection will be considered the same device. The key fields for an entity class must not change unless associated with a flush of that entity class.

Returns:

a set containing the fields that should not be wildcarded. May be null to indicate that all fields are key fields.

getName

java.lang.String getName()

Returns a user-friendly, unique name for this EntityClass

Returns:

the name of the entity class