WebItem.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.elephant.entities.web;
 
import java.io.Serializable;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import java.util.TreeSet;
import java.util.stream.Collectors;
import javax.persistence.AttributeOverride;
import javax.persistence.AttributeOverrides;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Embedded;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.Id;
import javax.persistence.ManyToMany;
import javax.persistence.OrderBy;
import org.turro.elephant.context.Application;
import org.turro.elephant.context.IConstructor;
import org.turro.elephant.web.actions.WebActions;
import org.turro.elephant.web.actions.WebLink;
import org.turro.html.HtmlContent;
import org.turro.icon.Icons;
import org.turro.jpa.embeddables.Wiki;
import org.turro.jpa.entity.IDaoEntity;
import org.turro.string.Phrases;
import org.turro.string.Strings;
 
@Entity
public class WebItem implements IDaoEntity, Serializable {
 
  @Id private String webTag;
  
  private WebItemType type;
  
  private String caption, image;
  private int ordering;
  
  @Embedded
  @AttributeOverrides({
    @AttributeOverride( name = "text", column = @Column(name = "summary")),
    @AttributeOverride( name = "wiki", column = @Column(name = "wsummary"))
  })
  private Wiki summary;
 
  @Embedded
  @AttributeOverrides({
    @AttributeOverride( name = "text", column = @Column(name = "description")),
    @AttributeOverride( name = "wiki", column = @Column(name = "wdescription"))
  })
  private Wiki description;
 
  @ManyToMany(fetch = FetchType.EAGER)
  @OrderBy("ordering")
  private Set<WebGoal> goals = new TreeSet<>();
 
  @ManyToMany(fetch = FetchType.EAGER)
  @OrderBy("ordering")
  private Set<WebItem> nexts = new TreeSet<>();
 
  @ElementCollection(fetch=FetchType.EAGER)
  private Set<String> externals = new HashSet<>();
 
  public String getWebTag() {
    return webTag;
  }
 
  public void setWebTag(String webTag) {
    this.webTag = webTag;
  }
 
  public WebItemType getType() {
    return type;
  }
 
  public void setType(WebItemType type) {
    this.type = type;
  }
 
  public String getCaption() {
    return caption;
  }
 
  public void setCaption(String caption) {
    this.caption = caption;
  }
 
  public String getImage() {
    return image;
  }
 
  public void setImage(String image) {
    this.image = image;
  }
 
  public int getOrdering() {
    return ordering;
  }
 
  public void setOrdering(int ordering) {
    this.ordering = ordering;
  }
 
  public Wiki getSummary() {
    if(summary == null) summary = new Wiki();
    return summary;
  }
 
  public void setSummary(Wiki summary) {
    this.summary = summary;
  }
 
  public Wiki getDescription() {
    if(description == null) description = new Wiki();
    return description;
  }
 
  public void setDescription(Wiki description) {
    this.description = description;
  }
 
  public Set<WebGoal> getGoals() {
    return goals;
  }
 
  public void setGoals(Set<WebGoal> goals) {
    this.goals = goals;
  }
 
  public Set<WebItem> getNexts() {
    return nexts;
  }
 
  public void setNexts(Set<WebItem> nexts) {
    this.nexts = nexts;
  }
 
  public Set<String> getExternals() {
    return externals;
  }
 
  public void setExternals(Set<String> externals) {
    this.externals = externals;
  }
 
  /* Utils */
  
  public String getPlainCompendium() {
    return summary == null ? "" : HtmlContent.plain(summary.getText(), 100);
  }
 
  public String getCompendium() {
    return summary == null ? "" : summary.getText();
  }
 
  public String getContent() {
    return description == null ? "" : description.getText();
  }
 
  public boolean isIcon() {
    return !Strings.isBlank(image) && !image.endsWith(".png");
  }
  
  public boolean isValid() {
    return webTag.matches("[A-Za-z0-9_-]+");
  }
  
  public Icons getIcons() {
    return Icons.from(image);
  }
  
  public String getItemLabel() {
    return Phrases.start(caption).add(webTag, "()").add(type.toString()).toString();
  }
 
  public void compose() {
    IConstructor constructor = Application.getApplication().getConstructor();
    if(constructor != null) {
      getSummary().compose(constructor);
      getDescription().compose(constructor);
    }
  }
  
  public Set<WebLink> getExternalLinks() {
    return externals.stream().map(ext -> WebActions.of(ext).link())
            .filter(wl -> !wl.isEmpty()).collect(Collectors.toSet());
  }
      
  @Override
  public int hashCode() {
    int hash = 7;
    hash = 71 * hash + Objects.hashCode(this.webTag);
    return hash;
  }
 
  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final WebItem other = (WebItem) obj;
    return Objects.equals(this.webTag, other.webTag);
  }
 
  /* IDaoEntity */
  
  @Override
  public Object entityId() {
    return webTag;
  }
 
  @Override
  public boolean isEmpty() {
    return Strings.isBlank(webTag) || Strings.isBlank(caption);
  }
 
}