org.apache.unomi.api.Metadata Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unomi-api Show documentation
Show all versions of unomi-api Show documentation
Main API of the Apache Unomi Context server
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.unomi.api;
import java.io.Serializable;
import java.util.LinkedHashSet;
import java.util.Set;
/**
* A class providing information about context server entities.
*
* @see MetadataItem
*/
public class Metadata implements Comparable, Serializable {
private static final long serialVersionUID = 7446061538573517071L;
/**
* Default scope, gathers default entities and can also be used to share entities across scopes.
*/
public static final String SYSTEM_SCOPE = "systemscope";
private String id;
private String name;
private String description;
private String scope;
private Set tags = new LinkedHashSet<>();
private Set systemTags = new LinkedHashSet<>();
private boolean enabled = true;
private boolean missingPlugins = false;
private boolean hidden = false;
private boolean readOnly = false;
/**
* Instantiates a new Metadata.
*/
public Metadata() {
}
/**
* Instantiates a new Metadata with the specified identifier.
*
* @param id the identifier for this Metadata
*/
public Metadata(String id) {
this.id = id;
}
/**
* Instantiates a new Metadata with the provided information.
*
* @param scope the scope for this Metadata
* @param id the identifier of the associated {@link Item}
* @param name the name
* @param description the description
*/
public Metadata(String scope, String id, String name, String description) {
this.scope = scope;
this.id = id;
this.name = name;
this.description = description;
}
/**
* Retrieves the identifier for the entity associated with this Metadata
*
* @return the identifier
*/
public String getId() {
return id;
}
/**
* Sets the id.
*
* @param id the id
*/
public void setId(String id) {
this.id = id;
}
/**
* Retrieves the name.
*
* @return the name
*/
public String getName() {
return name;
}
/**
* Sets the name.
*
* @param name the name
*/
public void setName(String name) {
this.name = name;
}
/**
* Retrieves the description.
*
* @return the description
*/
public String getDescription() {
return description;
}
/**
* Sets the description.
*
* @param description the description
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Retrieves the scope for the entity associated with this Metadata
*
* @return the scope for the entity associated with this Metadata
* @see Item Item for a deeper discussion of scopes
*/
public String getScope() {
return scope;
}
/**
* Sets the scope.
*
* @param scope the scope
*/
public void setScope(String scope) {
this.scope = scope;
}
/**
* Retrieves a set of {@link String} tag names associated with this Metadata
*
* @return a set of {@link String} tag names associated with this Metadata
*/
public Set getTags() {
return tags;
}
/**
* Sets the tags.
*
* @param tags the tag ids
*/
public void setTags(Set tags) {
this.tags = tags;
}
/**
* Retrieves a set of {@link String} system tag names associated with this Metadata
*
* @return a set of {@link String} system tag names associated with this Metadata
*/
public Set getSystemTags() {
return systemTags;
}
/**
* Sets the system tags.
*
* @param systemTags the system tag ids
*/
public void setSystemTags(Set systemTags) {
this.systemTags = systemTags;
}
/**
* Whether the associated entity is considered active by the context server, in particular to check if rules need to be created / triggered
*
* @return {@code true} if the associated entity is enabled, {@code false} otherwise
*/
public boolean isEnabled() {
return enabled;
}
/**
* Specifies whether the associated entity should be active or not.
*
* @param enabled {@code true} if the associated entity is enabled, {@code false} otherwise
*/
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
/**
* Whether the associated entity is waiting on additional plugins to become available to be able to properly perform its function.
*
* @return {@code true} if plugins are missing, {@code false} otherwise
*/
public boolean isMissingPlugins() {
return missingPlugins;
}
/**
* Specifies whether the associated entity is waiting on additional plugins to become available.
*
* @param missingPlugins {@code true} if plugins are missing, {@code false} otherwise
*/
public void setMissingPlugins(boolean missingPlugins) {
this.missingPlugins = missingPlugins;
}
/**
* Whether the associated entity is considered for internal purposes only and should therefore be hidden to accessing UIs.
*
* @return {@code true} if the associated entity needs to be hidden, {@code false} otherwise
*/
public boolean isHidden() {
return hidden;
}
/**
* Specifies whether the associated entity is hidden.
*
* @param hidden {@code true} if the associated entity needs to be hidden, {@code false} otherwise
*/
public void setHidden(boolean hidden) {
this.hidden = hidden;
}
/**
* Whether the associated entity can be accessed but not modified.
*
* @return {@code true} if the associated entity can be accessed but not modified, {@code false} otherwise
*/
public boolean isReadOnly() {
return readOnly;
}
/**
* Specifies whether the associated entity should be only accessed and not modified.
*
* @param readOnly {@code true} if the associated entity can be accessed but not modified, {@code false} otherwise
*/
public void setReadOnly(boolean readOnly) {
this.readOnly = readOnly;
}
public int compareTo(Metadata o) {
return getId().compareTo(o.getId());
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Metadata metadata = (Metadata) o;
if (!id.equals(metadata.id)) return false;
return !(scope != null ? !scope.equals(metadata.scope) : metadata.scope != null);
}
@Override
public int hashCode() {
int result = id.hashCode();
result = 31 * result + (scope != null ? scope.hashCode() : 0);
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy