Skip to main content

This CGIT instance is deprecated, and repositories have been moved to Gitlab or Github. See the repository descriptions for specific locations.

summaryrefslogtreecommitdiffstats
blob: 19075ac57a9fbe0e9d27af572bf7f93031727bc7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*******************************************************************************
 * Copyright (c) 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.wst.command.internal.env.core.fragment;

import java.util.Vector;

import org.eclipse.wst.command.internal.env.core.CommandFactory;
import org.eclipse.wst.command.internal.env.core.ICommandFactory;
import org.eclipse.wst.command.internal.env.core.data.DataMappingRegistry;
import org.eclipse.wst.common.frameworks.datamodel.AbstractDataModelOperation;

public abstract class CommandFactoryFragment implements CommandFragment 
{
  private Vector commands_;
  
  /**
   * Subclasses should override this method and return
   * an CommandFactory.
   * @return
   */
  public abstract ICommandFactory getICommandFactory();
  
  /**
   * All wizard fragments need to be cloneable.
  **/
  public abstract Object clone();
  
  protected CommandFactoryFragment( CommandFactoryFragment frag )
  {
    commands_ = frag.commands_;  
  }
  
  public CommandFactoryFragment()
  {
  }
  
  /**
   * 
   * @return Returns a unique identifier for this fragment.
   */
  public String getId()
  {
    return "";
  }
  
  /** 
    * Gets executable command associated with this fragment.
    *
    * @return returns the first child fragment for this fragment.  Returns
    * null when there is no first child.
  **/
  public CommandFactory getCommandFactory()
  {
    return null;
  }

  /** 
    * Gets the first child fragment for this fragment.
    *
    * @return returns the first child fragment for this fragment.  Returns
    * null when there is no first child.
  **/
  public CommandFragment getFirstSubFragment()
  {
	CommandFragment result = null;
	
    commands_ = createCommands();	

	if( commands_.size() > 0 )
	{
	  result = (ChildFragment)commands_.elementAt(0);
	}
	
	return result;
  }

  /**
    * Gets the next child fragment for this fragment.
    *
    * @return returns the next child fragment for this fragment.  Returns null
    * when there is no next child.
  **/
  public CommandFragment getNextSubFragment( CommandFragment fragment )
  {
	CommandFragment result = null;
		
	if( commands_ != null && fragment instanceof ChildFragment ) 
	{
	  ChildFragment child = (ChildFragment)fragment;
	  
	  int index = child.index_;
	
      if( index != -1 )
	  {
	    index++;
	  
	    if( index < commands_.size() )
		{
		  result = (CommandFragment)commands_.elementAt( index );
		}
	  }
	}
	
	return result;
  }
  
  /*
   * This method is called to retrieve the data mappings for this command fragment.
   */
  public void registerDataMappings( DataMappingRegistry registry )
  {
  }

  /**
   * 
   * @return If the commands for this fragment should not be run within a transaction then
   * this method should return true.  If the fragment does not care if it is run in a transaction
   * or not it should return false.
   */
  public boolean doNotRunInTransaction()
  {
    return false;
  }  
  
  private Vector createCommands()
  {
	Vector          commands = new Vector();
	ICommandFactory factory  = getICommandFactory();
	int             index    = 0;
		  
	while( factory != null && factory.hasNext() )
	{
	  AbstractDataModelOperation command = factory.getNextCommand();
			
	  commands.add( new ChildFragment( command, index++ ) );
	}
	
	return commands;
  }
  
  private class ChildFragment extends SimpleFragment
  {
	  int index_;
	
	  public ChildFragment( AbstractDataModelOperation command, int index )
	  {
	    super( command, command.getID() );
	    index_ = index;
	  }
  }
}

Back to the top