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