com.graphaware.relcount.full.internal.dto.relationship.CompactibleRelationshipImpl Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013 GraphAware
 *
 * This file is part of GraphAware.
 *
 * GraphAware is free software: you can redistribute it and/or modify it under the terms of
 * the GNU 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 General Public License for more details. You should have received a copy of
 * the GNU General Public License along with this program.  If not, see
 * .
 */

package com.graphaware.relcount.full.internal.dto.relationship;

import com.graphaware.propertycontainer.dto.common.property.ImmutableProperties;
import com.graphaware.propertycontainer.dto.common.relationship.HasTypeAndDirection;
import com.graphaware.propertycontainer.dto.common.relationship.HasTypeDirectionAndProperties;
import com.graphaware.propertycontainer.dto.string.relationship.BaseCopyMakingSerializableDirectedRelationship;
import com.graphaware.relcount.full.internal.dto.property.CompactibleProperties;
import com.graphaware.relcount.full.internal.dto.property.CompactiblePropertiesImpl;
import org.neo4j.graphdb.Direction;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.RelationshipType;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;

/**
 * Base-class for {@link CompactibleRelationship} implementations.
 */
public class CompactibleRelationshipImpl extends BaseCopyMakingSerializableDirectedRelationship implements CompactibleRelationship {

    private String string;

    /**
     * Construct a description. Please note that using this constructor, the actual properties on the
     * relationship are ignored! The provided properties are used instead. If the start node of this relationship is the same as the end node,
     * the direction will be resolved as {@link org.neo4j.graphdb.Direction#BOTH}.
     *
     * @param relationship Neo4j relationship to describe.
     * @param pointOfView  node which is looking at this relationship and thus determines its direction.
     * @param properties   to use as if they were in the relationship.
     */
    public CompactibleRelationshipImpl(Relationship relationship, Node pointOfView, Map properties) {
        super(relationship, pointOfView, properties);
    }

    /**
     * Construct a description.
     *
     * @param type       type.
     * @param direction  direction.
     * @param properties props.
     */
    public CompactibleRelationshipImpl(RelationshipType type, Direction direction, Map properties) {
        super(type, direction, properties);
    }

    /**
     * Construct a description from a string.
     *
     * @param string    string to construct description from. Must be of the form prefix + type#direction#key1#value1#key2#value2...
     *                  (assuming # separator).
     * @param prefix    of the string that should be removed before conversion.
     * @param separator of information, ideally a single character, must not be null or empty.
     */
    public CompactibleRelationshipImpl(String string, String prefix, String separator) {
        super(string, prefix, separator);
        this.string = string;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isMoreGeneralThan(HasTypeDirectionAndProperties> relationship) {
        return matches((HasTypeAndDirection) relationship) && getProperties().isMoreGeneralThan(relationship.getProperties());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isMoreSpecificThan(HasTypeDirectionAndProperties> relationship) {
        return matches((HasTypeAndDirection) relationship) && getProperties().isMoreSpecificThan(relationship.getProperties());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Set generateAllMoreGeneral(Collection unknownKeys) {
        return withDifferentProperties(getProperties().generateAllMoreGeneral(unknownKeys));
    }

    private Set withDifferentProperties(Set propertySets) {
        Set result = new TreeSet<>();

        for (CompactibleProperties propertySet : propertySets) {
            result.add(newRelationship(getType(), getDirection(), propertySet.getProperties()));
        }

        return result;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int compareTo(CompactibleRelationship that) {
        if (equals(that)) {
            return 0;
        } else if (isMoreGeneralThan(that)) {
            return 1;
        } else if (isMoreSpecificThan(that)) {
            return -1;
        }

        int result = getType().name().compareTo(that.getType().name());
        if (result != 0) {
            return result;
        }

        result = that.getDirection().compareTo(getDirection());
        if (result != 0) {
            return result;
        }

        return getProperties().compareTo(that.getProperties());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isMutuallyExclusive(HasTypeDirectionAndProperties> other) {
        return !matches((HasTypeAndDirection) other) || getProperties().isMutuallyExclusive(other.getProperties());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected CompactibleRelationship newRelationship(RelationshipType type, Direction direction, Map properties) {
        return new CompactibleRelationshipImpl(type, direction, properties);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected CompactibleProperties newProperties(Map properties) {
        return new CompactiblePropertiesImpl(properties);
    }

    @Override
    public String toString(String prefix, String separator) {
        if (string == null) {
            string = super.toString(prefix, separator);
        }
        return string;
    }
}