/* uDig - User Friendly Desktop Internet GIS client
* http://udig.refractions.net
* (C) 2004-2012, Refractions Research Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* (http://www.eclipse.org/legal/epl-v10.html), and the Refractions BSD
* License v1.0 (http://udig.refractions.net/files/bsd3-v10.html).
*/
package org.locationtech.udig.project.command.factory;
import java.util.List;
import org.locationtech.udig.project.ILayer;
import org.locationtech.udig.project.command.CompositeCommand;
import org.locationtech.udig.project.command.MapCommand;
import org.locationtech.udig.project.command.UndoableComposite;
import org.locationtech.udig.project.command.UndoableMapCommand;
import org.locationtech.udig.project.internal.commands.selection.BBoxSelectionCommand;
import org.locationtech.udig.project.internal.commands.selection.FIDSelectCommand;
import org.locationtech.udig.project.internal.commands.selection.NoSelectCommand;
import org.locationtech.udig.project.internal.commands.selection.SelectCommand;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.filter.Filter;
import com.vividsolutions.jts.geom.Envelope;
/**
* A factory which can be used to create all the standard selection commands.
*
* API use
*
* @author jeichar
* @since 0.3
*/
@SuppressWarnings("deprecation")
public class SelectionCommandFactory extends org.locationtech.udig.project.command.SelectionCommandFactory {
/**
* Creates a new SelectionCommandFactory object
*
* @return a new SelectionCommandFactory object
*/
public static SelectionCommandFactory getInstance() {
return instance;
}
private static final SelectionCommandFactory instance = new SelectionCommandFactory();
protected SelectionCommandFactory(){
// no op;
}
/**
* Creates a new {@linkplain BBoxSelectionCommand}
*
* @param bbox A bounding used as the filter, all features intersecting the bbox will be
* considered selected
* @param modifiers Options include: BBoxSelectionCommand.ADD, BBoxSelectionCommand.NONE,
* BBoxSelectionCommand.SUBTRACT
* @return A new BBoxSelectionCommand. The command should be sent to the
* {@linkplain SelectionManager}to be executed.
* @see Envelope
* @see MapCommand
*/
@Override
public UndoableMapCommand createBBoxSelectionCommand(Envelope bbox, int modifiers) {
return new BBoxSelectionCommand(bbox, modifiers);
}
/**
* Creates a new {@linkplain BBoxSelectionCommand}.
* Same as createBBoxSelectionCommand(bbox, BBoxSelectionCommand.NONE)
*
* @param bbox A bounding used as the filter, all features intersecting the bbox will be
* considered selected
* @return A new BBoxSelectionCommand. The command should be sent to the
* {@linkplain SelectionManager}to be executed.
* @see Envelope
* @see MapCommand
*/
@Override
public UndoableMapCommand createBBoxSelectionCommand( Envelope boundingBox ) {
return new BBoxSelectionCommand(boundingBox, BBoxSelectionCommand.NONE);
}
/**
* Creates a {@linkplain NoSelectCommand}
*
* @return a {@linkplain NoSelectCommand}object. The command should be sent to the
* {@linkplain SelectionManager}to be executed.
* @see MapCommand
*/
@Override
public UndoableMapCommand createNoSelectCommand() {
return new NoSelectCommand();
}
/**
* Create a MapCommand that sets the layer selection to be a fidfilter.
*
* @return a {@linkplain FIDSelectCommand}
* @see MapCommand
*/
@Override
public UndoableMapCommand createFIDSelectCommand(ILayer layer, String fid) {
return new FIDSelectCommand(layer, fid);
}
/**
* Create a MapCommand that sets the layer selection to be a fidfilter.
*
* @return a {@linkplain FIDSelectCommand}
* @see MapCommand
*/
@Override
public UndoableMapCommand createFIDSelectCommand(ILayer layer, SimpleFeature feature) {
return new FIDSelectCommand(layer, feature.getID());
}
/**
* Create a MapCommand that sets the layer selection to be the filter.
*
* @return a {@linkplain SelectCommand}
* @see MapCommand
*/
@Override
public UndoableMapCommand createSelectCommand(ILayer layer, Filter filter) {
return new SelectCommand(layer, filter);
}
/**
* Create a CompositeCommand
*
* @param commands the commands to be executed as a single command
* @return a {@linkplain CompositeCommand}
* @see MapCommand
*/
@Override
public MapCommand createCompositeCommand(List<? extends MapCommand> commands) {
return new CompositeCommand(commands);
}
/**
* Create a CompositeCommand
*
* @param commands the commands to be executed as a single command
* @return a {@linkplain CompositeCommand}
* @see MapCommand
*/
@Override
public UndoableMapCommand createUndoableCompositeCommand(List<? extends UndoableMapCommand> commands) {
return new UndoableComposite(commands);
}
}