SecureGraphConcept.java

package io.lumify.securegraph.model.ontology;

import io.lumify.core.exception.LumifyResourceNotFoundException;
import io.lumify.core.model.ontology.Concept;
import io.lumify.core.model.ontology.OntologyProperty;
import io.lumify.core.model.ontology.OntologyRepository;
import io.lumify.core.model.properties.LumifyProperties;
import io.lumify.core.util.JSONUtil;
import org.codehaus.plexus.util.IOUtil;
import org.json.JSONArray;
import org.securegraph.Authorizations;
import org.securegraph.Property;
import org.securegraph.Vertex;
import org.securegraph.property.StreamingPropertyValue;
import org.securegraph.util.IterableUtils;

import java.io.IOException;
import java.util.*;

public class SecureGraphConcept extends Concept {
    private static Set<String> PROPERTIES_NOT_IN_METADATA = new HashSet<>();
    private final Vertex vertex;

    static {
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.DISPLAY_NAME.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.DISPLAY_TYPE.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.GLYPH_ICON.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.ONTOLOGY_TITLE.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.CONCEPT_TYPE.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.COLOR.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.SUBTITLE_FORMULA.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.TITLE_FORMULA.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.TIME_FORMULA.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.ADD_RELATED_CONCEPT_WHITE_LIST.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.SEARCHABLE.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.ADDABLE.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(LumifyProperties.USER_VISIBLE.getPropertyName());
        PROPERTIES_NOT_IN_METADATA.add(SecureGraphOntologyRepository.ONTOLOGY_FILE_PROPERTY_NAME);
    }

    public SecureGraphConcept(Vertex vertex) {
        this(vertex, null, null);
    }

    public SecureGraphConcept(Vertex vertex, String parentConceptIRI, Collection<OntologyProperty> properties) {
        super(parentConceptIRI, properties);
        this.vertex = vertex;
    }

    @Override
    public String getIRI() {
        return LumifyProperties.ONTOLOGY_TITLE.getPropertyValue(vertex);
    }

    @Override
    public String getTitle() {
        return LumifyProperties.ONTOLOGY_TITLE.getPropertyValue(vertex);
    }

    @Override
    public boolean hasGlyphIconResource() {
        // TODO: This can be changed to GLYPH_ICON.getPropertyValue(vertex) once ENTITY_IMAGE_URL is added
        return vertex.getPropertyValue(LumifyProperties.GLYPH_ICON.getPropertyName()) != null;
    }

    @Override
    public String getColor() {
        return LumifyProperties.COLOR.getPropertyValue(vertex);
    }

    @Override
    public String getDisplayName() {
        return LumifyProperties.DISPLAY_NAME.getPropertyValue(vertex);
    }

    @Override
    public String getDisplayType() {
        return LumifyProperties.DISPLAY_TYPE.getPropertyValue(vertex);
    }

    @Override
    public String getTitleFormula() {
        return LumifyProperties.TITLE_FORMULA.getPropertyValue(vertex);
    }

    @Override
    public Boolean getSearchable() {
        return LumifyProperties.SEARCHABLE.getPropertyValue(vertex);
    }

    @Override
    public String getSubtitleFormula() {
        return LumifyProperties.SUBTITLE_FORMULA.getPropertyValue(vertex);
    }

    @Override
    public String getTimeFormula() {
        return LumifyProperties.TIME_FORMULA.getPropertyValue(vertex);
    }

    @Override
    public boolean getUserVisible() {
        return LumifyProperties.USER_VISIBLE.getPropertyValue(vertex, true);
    }

    @Override
    public String[] getIntents() {
        return IterableUtils.toArray(LumifyProperties.INTENT.getPropertyValues(vertex), String.class);
    }

    @Override
    public void addIntent(String intent, Authorizations authorizations) {
        LumifyProperties.INTENT.addPropertyValue(vertex, intent, intent, OntologyRepository.VISIBILITY.getVisibility(), authorizations);
    }

    @Override
    public Map<String, String> getMetadata() {
        Map<String, String> metadata = new HashMap<>();
        for (Property p : vertex.getProperties()) {
            if (PROPERTIES_NOT_IN_METADATA.contains(p.getName())) {
                continue;
            }
            metadata.put(p.getName(), p.getValue().toString());
        }
        return metadata;
    }

    @Override
    public List<String> getAddRelatedConceptWhiteList() {
        JSONArray arr = LumifyProperties.ADD_RELATED_CONCEPT_WHITE_LIST.getPropertyValue(vertex);
        if (arr == null) {
            return null;
        }
        return JSONUtil.toStringList(arr);
    }

    @Override
    public void setProperty(String name, Object value, Authorizations authorizations) {
        getVertex().setProperty(name, value, OntologyRepository.VISIBILITY.getVisibility(), authorizations);
    }

    @Override
    public void removeProperty(String name, Authorizations authorizations) {
        getVertex().removeProperty(name, authorizations);
    }

    @Override
    public byte[] getGlyphIcon() {
        try {
            StreamingPropertyValue spv = LumifyProperties.GLYPH_ICON.getPropertyValue(getVertex());
            if (spv == null) {
                return null;
            }
            return IOUtil.toByteArray(spv.getInputStream());
        } catch (IOException e) {
            throw new LumifyResourceNotFoundException("Could not retrieve glyph icon");
        }
    }

    @Override
    public byte[] getMapGlyphIcon() {
        try {
            StreamingPropertyValue spv = LumifyProperties.MAP_GLYPH_ICON.getPropertyValue(getVertex());
            if (spv == null) {
                return null;
            }
            return IOUtil.toByteArray(spv.getInputStream());
        } catch (IOException e) {
            throw new LumifyResourceNotFoundException("Could not retrieve map glyph icon");
        }
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 79 * hash + (this.vertex != null ? this.vertex.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final SecureGraphConcept other = (SecureGraphConcept) obj;
        if (this.vertex != other.vertex && (this.vertex == null || !this.vertex.equals(other.vertex))) {
            return false;
        }
        return true;
    }

    public Vertex getVertex() {
        return this.vertex;
    }
}