org.apache.unomi.api

Class Metadata

java.lang.Object

org.apache.unomi.api.Metadata

All Implemented Interfaces:

Serializable, Comparable<Metadata>

public class Metadata
extends Object
implements Comparable<Metadata>, Serializable

A class providing information about context server entities.

See Also:

MetadataItem, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_SCOPE Default scope, gathers default entities and can also be used to share entities across scopes.

Constructor Summary

Constructors

Constructor and Description
Metadata() Instantiates a new Metadata.
Metadata(String id) Instantiates a new Metadata with the specified identifier.
Metadata(String scope, String id, String name, String description) Instantiates a new Metadata with the provided information.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Metadata o)
boolean	equals(Object o)
String	getDescription() Retrieves the description.
String	getId() Retrieves the identifier for the entity associated with this Metadata
String	getName() Retrieves the name.
String	getScope() Retrieves the scope for the entity associated with this Metadata
Set<String>	getSystemTags() Retrieves a set of String system tag names associated with this Metadata
Set<String>	getTags() Retrieves a set of String tag names associated with this Metadata
int	hashCode()
boolean	isEnabled() Whether the associated entity is considered active by the context server, in particular to check if rules need to be created / triggered
boolean	isHidden() Whether the associated entity is considered for internal purposes only and should therefore be hidden to accessing UIs.
boolean	isMissingPlugins() Whether the associated entity is waiting on additional plugins to become available to be able to properly perform its function.
boolean	isReadOnly() Whether the associated entity can be accessed but not modified.
void	setDescription(String description) Sets the description.
void	setEnabled(boolean enabled) Specifies whether the associated entity should be active or not.
void	setHidden(boolean hidden) Specifies whether the associated entity is hidden.
void	setId(String id) Sets the id.
void	setMissingPlugins(boolean missingPlugins) Specifies whether the associated entity is waiting on additional plugins to become available.
void	setName(String name) Sets the name.
void	setReadOnly(boolean readOnly) Specifies whether the associated entity should be only accessed and not modified.
void	setScope(String scope) Sets the scope.
void	setSystemTags(Set<String> systemTags) Sets the system tags.
void	setTags(Set<String> tags) Sets the tags.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_SCOPE

public static final String SYSTEM_SCOPE

Default scope, gathers default entities and can also be used to share entities across scopes.

See Also:

Constant Field Values

Constructor Detail

Metadata

public Metadata()

Instantiates a new Metadata.

Metadata

public Metadata(String id)

Instantiates a new Metadata with the specified identifier.

Parameters:

id - the identifier for this Metadata

Metadata

public Metadata(String scope,
                String id,
                String name,
                String description)

Instantiates a new Metadata with the provided information.

Parameters:

scope - the scope for this Metadata

id - the identifier of the associated Item

name - the name

description - the description

Method Detail

getId

public String getId()

Retrieves the identifier for the entity associated with this Metadata

Returns:

the identifier

setId

public void setId(String id)

Sets the id.

Parameters:

id - the id

getName

public String getName()

Retrieves the name.

Returns:

the name

setName

public void setName(String name)

Sets the name.

Parameters:

name - the name

getDescription

public String getDescription()

Retrieves the description.

Returns:

the description

setDescription

public void setDescription(String description)

Sets the description.

Parameters:

description - the description

getScope

public String getScope()

Retrieves the scope for the entity associated with this Metadata

Returns:

the scope for the entity associated with this Metadata

See Also:

Item for a deeper discussion of scopes

setScope

public void setScope(String scope)

Sets the scope.

Parameters:

scope - the scope

getTags

public Set<String> getTags()

Retrieves a set of String tag names associated with this Metadata

Returns:

a set of String tag names associated with this Metadata

setTags

public void setTags(Set<String> tags)

Sets the tags.

Parameters:

tags - the tag ids

getSystemTags

public Set<String> getSystemTags()

Retrieves a set of String system tag names associated with this Metadata

Returns:

a set of String system tag names associated with this Metadata

setSystemTags

public void setSystemTags(Set<String> systemTags)

Sets the system tags.

Parameters:

systemTags - the system tag ids

isEnabled

public boolean isEnabled()

Whether the associated entity is considered active by the context server, in particular to check if rules need to be created / triggered

Returns:

true if the associated entity is enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Specifies whether the associated entity should be active or not.

Parameters:

enabled - true if the associated entity is enabled, false otherwise

isMissingPlugins

public boolean isMissingPlugins()

Whether the associated entity is waiting on additional plugins to become available to be able to properly perform its function.

Returns:

true if plugins are missing, false otherwise

setMissingPlugins

public void setMissingPlugins(boolean missingPlugins)

Specifies whether the associated entity is waiting on additional plugins to become available.

Parameters:

missingPlugins - true if plugins are missing, false otherwise

isHidden

public boolean isHidden()

Whether the associated entity is considered for internal purposes only and should therefore be hidden to accessing UIs.

Returns:

true if the associated entity needs to be hidden, false otherwise

setHidden

public void setHidden(boolean hidden)

Specifies whether the associated entity is hidden.

Parameters:

hidden - true if the associated entity needs to be hidden, false otherwise

isReadOnly

public boolean isReadOnly()

Whether the associated entity can be accessed but not modified.

Returns:

true if the associated entity can be accessed but not modified, false otherwise

setReadOnly

public void setReadOnly(boolean readOnly)

Specifies whether the associated entity should be only accessed and not modified.

Parameters:

readOnly - true if the associated entity can be accessed but not modified, false otherwise

compareTo

public int compareTo(Metadata o)

Specified by:

compareTo in interface Comparable<Metadata>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object