001/*
002 * Copyright (c) 2007-2017 Xplenty, Inc. All Rights Reserved.
003 *
004 * Project and contact information: http://www.cascading.org/
005 *
006 * This file is part of the Cascading project.
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020
021package cascading.flow.planner.process;
022
023import java.util.Collection;
024import java.util.Map;
025import java.util.Set;
026
027import cascading.flow.FlowElement;
028import cascading.flow.planner.graph.ElementGraph;
029import cascading.pipe.Group;
030import cascading.tap.Tap;
031
032/**
033 *
034 */
035public interface ProcessModel
036  {
037  String getID();
038
039  int getOrdinal();
040
041  String getName();
042
043  /**
044   * Method getProcessAnnotations returns an immutable Map of platform specific annotations or meta-data
045   * that describe the current model type.
046   * <p/>
047   * Use {@link #addProcessAnnotation(Enum)} or {@link #addProcessAnnotation(String, String)} to insert
048   * annotations or meta-data.
049   *
050   * @return an immutable Map
051   */
052  Map<String, String> getProcessAnnotations();
053
054  void addProcessAnnotation( Enum annotation );
055
056  void addProcessAnnotation( String key, String value );
057
058  Collection<Group> getGroups();
059
060  Set<Tap> getSourceTaps();
061
062  Set<Tap> getSinkTaps();
063
064  int getSubmitPriority();
065
066  Set<FlowElement> getSinkElements();
067
068  Set<FlowElement> getSourceElements();
069
070  Map<String, Tap> getTrapMap();
071
072  ElementGraph getElementGraph();
073  }