sentilo-catalog-web/src/main/java/org/sentilo/web/catalog/domain/Component.java
/*
* Sentilo
*
* Original version 1.4 Copyright (C) 2013 Institut Municipal d’Informà tica, Ajuntament de
* Barcelona. Modified by Opentrends adding support for multitenant deployments and SaaS.
* Modifications on version 1.5 Copyright (C) 2015 Opentrends Solucions i Sistemes, S.L.
*
*
* This program is licensed and may be used, modified and redistributed under the terms of the
* European Public License (EUPL), either version 1.1 or (at your option) any later version as soon
* as they are approved by the European Commission.
*
* Alternatively, you may redistribute and/or modify this program under the terms of the GNU Lesser
* General Public License as published by the Free Software Foundation; either version 3 of the
* License, or (at your option) any later version.
*
* 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 licenses for the specific language governing permissions, limitations and more details.
*
* You should have received a copy of the EUPL1.1 and the LGPLv3 licenses along with this program;
* if not, you may find them at:
*
* https://joinup.ec.europa.eu/software/page/eupl/licence-eupl http://www.gnu.org/licenses/ and
* https://www.gnu.org/licenses/lgpl.txt
*/
package org.sentilo.web.catalog.domain;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import org.hibernate.validator.constraints.URL;
import org.sentilo.common.domain.TechnicalDetails;
import org.sentilo.web.catalog.utils.CatalogUtils;
import org.sentilo.web.catalog.utils.CompoundKeyBuilder;
import org.sentilo.web.catalog.utils.Constants;
import org.sentilo.web.catalog.utils.enums.EntityType;
import org.springframework.data.annotation.Id;
import org.springframework.data.annotation.Transient;
import org.springframework.data.mongodb.core.mapping.Document;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.util.StringUtils;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
@Document
public class Component implements FederatedResource, CatalogDocument, SectorResourceGranted, EntityResource, AlphabeticalSortable {
private static final long serialVersionUID = 1L;
@Id
private String id;
@NotBlank
@Pattern(regexp = Constants.VALIDATION_ENTITY_NAME_REGEXP)
private String name;
private String description;
@NotBlank
private String providerId;
@DateTimeFormat(pattern = Constants.DATETIME_FORMAT)
private Date createdAt;
private String createdBy;
@DateTimeFormat(pattern = Constants.DATETIME_FORMAT)
private Date updatedAt;
private String updatedBy;
private int mobile = Constants.MOBILE;
private String parentId;
@JsonInclude(value = Include.NON_EMPTY)
private String tags;
private Boolean publicAccess = Boolean.FALSE;
@NotBlank
private String componentType;
private String geodeticSystem;
private Location location;
private RoutePointList routePointList;
@URL(regexp = Constants.VALIDATION_EMPTY_HTTP_HTTPS_URL)
private String photoUrl;
private String tenantId;
private Set<String> tenantsAuth;
private Set<String> tenantsMapVisible;
private Set<String> tenantsListVisible;
private List<SectorGrant> sectors;
private Boolean federatedResource = Boolean.FALSE;
private String federatedServiceId;
// Additional info
@JsonInclude(value = Include.NON_EMPTY)
private Map<String, String> additionalInfo;
@JsonInclude(value = Include.NON_NULL)
private TechnicalDetails technicalDetails;
@Size(max = 20)
private String displayName;
@URL(regexp = Constants.VALIDATION_EMPTY_HTTP_HTTPS_URL)
private String extendedDetailUrl;
/**
* Contains a set of locations where each element is a candidate to be member of the
* routePointList
*/
@JsonIgnore
@Transient
private transient Set<Location> locationRoutePointsCandidates;
public Component() {
tenantsAuth = new HashSet<String>();
tenantsListVisible = new HashSet<String>();
tenantsMapVisible = new HashSet<String>();
sectors = new ArrayList<SectorGrant>();
}
public Component(final String id) {
this();
this.id = id;
if (StringUtils.hasText(id)) {
splitId();
}
}
public static String buildId(final String providerId, final String name) {
return CompoundKeyBuilder.buildCompoundKey(providerId, name);
}
@Override
public boolean equals(final Object obj) {
if (!(obj instanceof Component) || id == null) {
return false;
}
final Component other = (Component) obj;
return getId().equals(other.getId());
}
@Override
public int hashCode() {
// Hashcode return must be consistent with the equals method
final int prime = 23;
int result = 1;
result = prime * result + (id == null ? 0 : id.hashCode());
return result;
}
@Override
public String getId() {
if (!StringUtils.hasText(id) && StringUtils.hasText(name) && StringUtils.hasText(providerId)) {
id = buildId(providerId, name);
}
return id;
}
public String getFriendlyName() {
return StringUtils.hasText(displayName) ? new StringBuilder(displayName).append(" (").append(name).append(")").toString() : name;
}
public boolean addLocationCandidate(final Location candidate) {
if (locationRoutePointsCandidates == null) {
locationRoutePointsCandidates = new HashSet<Location>();
}
return locationRoutePointsCandidates.add(candidate);
}
public boolean hasLocation() {
return location != null && location.getNumberOfCoordinates() > 0;
}
@JsonIgnore
@Override
public String getEntityOwner() {
return providerId;
}
public void setId(final String id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(final String name) {
this.name = name;
}
public String getDescription() {
return description;
}
public void setDescription(final String description) {
this.description = description;
}
@Override
public Date getCreatedAt() {
return createdAt;
}
@Override
public void setCreatedAt(final Date createdAt) {
this.createdAt = createdAt;
}
@Override
public Date getUpdatedAt() {
return updatedAt;
}
@Override
public void setUpdatedAt(final Date updatedAt) {
this.updatedAt = updatedAt;
}
public Location getLocation() {
return location;
}
public void setLocation(final Location location) {
this.location = location;
}
public int getMobile() {
return mobile;
}
@JsonIgnore
public boolean isMobileComponent() {
return mobile == Constants.MOBILE;
}
@JsonIgnore
public boolean isStaticComponent() {
return mobile == Constants.STATIC;
}
public void setMobile(final int mobile) {
this.mobile = mobile;
}
public String getParentId() {
return parentId;
}
public void setParentId(final String parentId) {
this.parentId = parentId;
}
@JsonIgnore
public boolean isRoot() {
return !StringUtils.hasText(parentId);
}
public String getTags() {
return tags;
}
@JsonIgnore
public List<String> getTagsAsList() {
return CatalogUtils.tagsToStringList(tags);
}
public void setTags(final String tags) {
this.tags = tags;
}
public Boolean getPublicAccess() {
return publicAccess;
}
public void setPublicAccess(final Boolean publicAccess) {
this.publicAccess = publicAccess;
}
public String getComponentType() {
return componentType;
}
public void setComponentType(final String componentType) {
this.componentType = componentType;
}
public String getGeodeticSystem() {
return geodeticSystem;
}
public void setGeodeticSystem(final String geodeticSystem) {
this.geodeticSystem = geodeticSystem;
}
public String getProviderId() {
return providerId;
}
public void setProviderId(final String providerId) {
this.providerId = providerId;
}
public RoutePointList getRoutePointList() {
return routePointList;
}
public void setRoutePointList(final RoutePointList routePointList) {
this.routePointList = routePointList;
}
public String getPhotoUrl() {
return photoUrl;
}
public void setPhotoUrl(final String photoUrl) {
this.photoUrl = photoUrl;
}
@Override
public String getTenantId() {
return tenantId;
}
@Override
public void setTenantId(final String tenantId) {
this.tenantId = tenantId;
}
public Map<String, String> getAdditionalInfo() {
return additionalInfo;
}
public void setAdditionalInfo(final Map<String, String> additionalInfo) {
this.additionalInfo = additionalInfo;
}
public TechnicalDetails getTechnicalDetails() {
return technicalDetails;
}
public void setTechnicalDetails(final TechnicalDetails technicalDetails) {
this.technicalDetails = technicalDetails;
}
public Set<Location> getLocationCandidates() {
return locationRoutePointsCandidates;
}
@Override
public Set<String> getTenantsAuth() {
return tenantsAuth;
}
@Override
public void setTenantsAuth(final Set<String> tenantsAuth) {
this.tenantsAuth = tenantsAuth;
}
@Override
public String getCreatedBy() {
return createdBy;
}
@Override
public void setCreatedBy(final String createdBy) {
this.createdBy = createdBy;
}
@Override
public String getUpdatedBy() {
return updatedBy;
}
@Override
public void setUpdatedBy(final String updatedBy) {
this.updatedBy = updatedBy;
}
public Set<String> getTenantsMapVisible() {
return tenantsMapVisible;
}
public void setTenantsMapVisible(final Set<String> tenantsMapVisible) {
this.tenantsMapVisible = tenantsMapVisible;
}
@Override
public Set<String> getTenantsListVisible() {
return tenantsListVisible;
}
@Override
public void setTenantsListVisible(final Set<String> tenantsListVisible) {
this.tenantsListVisible = tenantsListVisible;
}
@JsonIgnore
@Override
public String getSortableValue() {
return name;
}
public void setFederatedResource(final Boolean federatedResource) {
this.federatedResource = federatedResource;
}
public String getFederatedServiceId() {
return federatedServiceId;
}
public void setFederatedServiceId(final String federatedServiceId) {
this.federatedServiceId = federatedServiceId;
}
protected void splitId() {
// If Id is a compound key, split it to get its parts
final String[] tokens = CompoundKeyBuilder.splitCompoundKey(id);
if (tokens.length == 2) {
providerId = tokens[0];
name = tokens[1];
}
}
@Override
public Boolean getFederatedResource() {
return federatedResource;
}
@Override
public List<SectorGrant> getSectors() {
return sectors;
}
@Override
public void setSectors(final List<SectorGrant> sectors) {
this.sectors = sectors;
}
@JsonIgnore
@Override
public EntityType getEntityType() {
return EntityType.PROVIDER;
}
public String getDisplayName() {
return displayName;
}
public void setDisplayName(final String displayName) {
this.displayName = displayName;
}
public String getExtendedDetailUrl() {
return extendedDetailUrl;
}
public void setExtendedDetailUrl(final String extendedDetailUrl) {
this.extendedDetailUrl = extendedDetailUrl;
}
}