PhaseDefinition.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.phase;
 
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.turro.entities.IElephantEntity;
import org.turro.security.ConceptPermission;
import org.turro.security.ConceptPermissionMap;
import org.turro.util.CompareUtil;
 
public class PhaseDefinition implements Comparable<PhaseDefinition> {
 
  private final int index;
  private final String name;
  private final Set<PhaseType> types;
  private final Map<String, Integer> mapping = new HashMap<>();
  private final Set<String> documentation = new HashSet<>();
 
  private final ConceptPermissionMap permissions = new ConceptPermissionMap();
 
  private String icon, description;
 
  public PhaseDefinition icon(String icon) {
    this.icon = icon;
    return this;
  }
  
  public PhaseDefinition described(String description) {
    this.description = description;
    return this;
  }
  
  public PhaseDefinition addMapping(String targetEntity, Integer targetPhase) {
    this.mapping.put(targetEntity, targetPhase);
    return this;
  }
  
  public PhaseDefinition addDocumentation(String documentation) {
    this.documentation.add(documentation);
    return this;
  }
 
  public PhaseDefinition addPermission(ConceptPermission permission) {
    permissions.put(permission);
    return this;
  }
 
  public int getIndex() {
    return index;
  }
 
  public String getName() {
    return name;
  }
 
  public Set<PhaseType> getTypes() {
    return types;
  }
 
  public boolean anyStringMatch(Collection<String> types) {
    return anyTypeMatch(types.stream().map(t -> PhaseType.valueOf(t)).toList());
  }
  
  public boolean anyTypeMatch(Collection<PhaseType> types) {
    return this.types.stream().anyMatch(types::contains);
  }
  
  public String getIconName() {
    return icon;
  }
 
  public String getDescription() {
    return description;
  }
 
  public Map<String, Integer> getMapping() {
    return mapping;
  }
 
  public Set<String> getDocumentation() {
    return documentation;
  }
 
  public ConceptPermission getPermission(String name, IElephantEntity iee) {
    return Optional.ofNullable(permissions.get(name, iee)).orElse(null);
  }
 
  public Collection<String> getConcepts() {
    return permissions.concepts();
  }
  
  /* Compare */
  
  @Override
  public int compareTo(PhaseDefinition o) {
    int result = Integer.compare(index, o.index);
    if(result == 0) {
      result = CompareUtil.compare(name, o.name);
    }
    return result;
  }
  
  /* Factory */
  
  public static PhaseDefinition create(int index, String name, Set<PhaseType> types) {
    return new PhaseDefinition(index, name, types);
  }
  
  private PhaseDefinition(int index, String name, Set<PhaseType> types) {
    this.index = index;
    this.name = name;
    this.types = types;
  }
 
}