catalog/src/main/java/org/apache/atlas/catalog/projection/Relation.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.atlas.catalog.projection;

import com.tinkerpop.pipes.Pipe;
import org.apache.atlas.catalog.VertexWrapper;
import org.apache.atlas.catalog.definition.ResourceDefinition;

import java.util.Collection;

/**
 * Represents the relationship from one vertex to another via an edge.
 */
public interface Relation {
    /**
     * Traverse the relation.
     *
     * @param vWrapper vertex to start traversal from
     *
     * @return results of the traversal
     */
    Collection<RelationSet> traverse(VertexWrapper vWrapper);

    /**
     * Get the pipe representation of the traversal.
     *
     * @return pipe representation
     */
    Pipe asPipe();

    /**
     * Get the associated resource definition.
     *
     * @return associated resource definition
     */
    ResourceDefinition getResourceDefinition();
}