com.graphaware.common.policy.fluent.IncludeRelationships Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common Show documentation
General-Purpose Library of Neo4j-Related Code
There is a newer version: 4.2.0.58
/*
 * Copyright (c) 2013-2016 GraphAware
 *
 * This file is part of the GraphAware Framework.
 *
 * GraphAware Framework 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.common.policy.fluent;

import com.graphaware.common.description.predicate.Predicate;
import com.graphaware.common.description.property.DetachedPropertiesDescription;
import com.graphaware.common.description.property.WildcardPropertiesDescription;
import org.neo4j.graphdb.Direction;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.RelationshipType;

import java.util.Collections;

/**
 * An implementation of {@link com.graphaware.common.policy.RelationshipInclusionPolicy} that is entirely configurable using its fluent interface.
 */
public class IncludeRelationships extends BaseIncludeRelationships {

    /**
     * Get a relationship inclusion policy that includes all relationships as the base-line for further configuration.
     * 
     * Note that if you want to simply include all relationships, it is more efficient to use {@link com.graphaware.common.policy.all.IncludeAllRelationships}.
     *
     * @return a policy including all relationships.
     */
    public static IncludeRelationships all() {
        return new IncludeRelationships(Direction.BOTH, new String[0], new WildcardPropertiesDescription(Collections.emptyMap()));
    }

    /**
     * Create a new policy.
     *
     * @param direction             that matching relationships must have, {@link Direction#BOTH} for both.
     * @param relationshipTypes     one of which the matching relationships must have, empty for all.
     * @param propertiesDescription of the matching relationships.
     */
    protected IncludeRelationships(Direction direction, String[] relationshipTypes, DetachedPropertiesDescription propertiesDescription) {
        super(direction, relationshipTypes, propertiesDescription);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected IncludeRelationships newInstance(Direction direction, String... relationshipTypes) {
        return new IncludeRelationships(direction, relationshipTypes, getPropertiesDescription());
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected IncludeRelationships newInstance(DetachedPropertiesDescription propertiesDescription) {
        return new IncludeRelationships(getDirection(), getRelationshipTypes(), propertiesDescription);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected Iterable doGetAll(GraphDatabaseService database) {
        return database.getAllRelationships();
    }
}