Application: gvSIG desktop » gvSIG tools: Vector editing

==================================

Usefull maven "howtos" and FAQs

==================================

.. contents::

How to reduce the process of "install" to run as fast as possible.

-------------------------------------------------------------------

Can reduce install execution skiping test execution and compilation,

javadoc generation, test signature checking, license checking, and 

attach sources in jar.

  mvn  -Danimal.sniffer.skip=true -Dmaven.test.skip=true -Dsource.skip=true -DskipTests -Dmaven.javadoc.skip=true install

How to increment the build number of gvSIG plugins

----------------------------------------------------

To increase the build number of gvSIG plugins, yo can do:

  mvn -Dincrease-build-number process-sources

How to deploy a package of a gvSIG plugin

--------------------------------------------

Yo can deploy the package of a gvSIG plugin with:

  mvn -Ddeploy-package -Duser=USER -Dpassword=PASSWORD install

Notes:

- Require that the gvsig.package.info.poolURL property that this set to the correct value.

- The process uses WEBDAV to upload the packages, gvspkg and gvspki, and require 

  access to write in the location specified by gvsig.package.info.poolURL

- If "user" or "password" is not present, the process ask its each time it need.

- If folder specified in  gvsig.package.info.poolURL does not exist, the process try to create it.

- The process create a file "addon-request.txt" in the target with the information to 

  add to the ticket to request the update of the package in the main repository of

  packages of gvSIG.

How to skip attach sources in jar from command line

------------------------------------------------------

If in the project is enabled by default the generation of jar whith 

the sources of the project, you can disable this setting the property

"source.skip" to true in the command line::

    mvn -Dsource.skip=true  install

How to skip test compile from command line

--------------------------------------------

You can skip the compilation of test setting the propety "maven.test.skip" 

to true in the command line::

    mvn -Dmaven.test.skip=true  install

How to skip test execution from command line

----------------------------------------------

You can skip the tests execution setting the propety "skipTests" to true

in the command line::

    mvn -DskipTests install

How to skip javadoc generation from command line

--------------------------------------------------

You can skip the javadoc generation setting the property

"maven.javadoc.skip" to true in the command line::

    mvn -Dmaven.javadoc.skip=true  install

How to skip test signature cheks from command line

---------------------------------------------------

You can skip the signature check setting the property

"animal.sniffer.skip" to true in the command line::

    mvn -Danimal.sniffer.skip=true install

How to install a project without install submodules

----------------------------------------------------------

To install a project with submodules and only install the

parent project without submodules use the option "--non-recursive" ::

    mvn --non-recursive install

How to skip test compilation

--------------------------------

To configure a project to don't run the compilation

of test you can add to this pom the next configuration of

the plugin "maven-compiler-plugin"::

  <build>

    <plugins>

      ...

      <plugin>

        <!-- Skip compilation tests -->

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-compiler-plugin</artifactId>

        <executions>

          <execution>

            <id>default-testCompile</id>

            <phase>process-test-sources</phase>

            <goals>

              <goal>testCompile</goal>

            </goals>

            <configuration>

              <skip>true</skip>

            </configuration>

          </execution>

        </executions>

      </plugin>

      ...

    </plugins>

  </build>

Skip test execution

----------------------

To configure a project to don't run the execution

of test you can add to this pom the next configuration of

the plugin "maven-surefire-plugin"::

  <build>

    <plugins>

      ...

      <plugin>

        <!-- Skip test execution -->

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-surefire-plugin</artifactId>

        <configuration>

          <skipTests>true</skipTests>

        </configuration>

      </plugin>

      ...

    </plugins>

  </build>

Continue on test failure

-----------------------------

You can configure a project to continue on test execution 

failure. To do this add to the pom of the project the next 

configuration of plugin "maven-surefire-plugin" ::

  <build>

    <plugins>

      ...

      <plugin>

        <!-- Continue on test failure -->

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-surefire-plugin</artifactId>

        <configuration>

          <testFailureIgnore>true</testFailureIgnore>

        </configuration>

      </plugin>

      ...

    </plugins>

  </build>

Set java compatibility

--------------------------

To set the compatibility with a java version  add to the 

pom of the project the next configuration of plugin 

"maven-compiler-plugin" ::

  <build>

    <plugins>

      ...

      <plugin>

          <!-- Set java compatibility -->

          <groupId>org.apache.maven.plugins</groupId>

          <artifactId>maven-compiler-plugin</artifactId>

          <configuration>

              <source>1.5</source>

              <target>1.5</target>

              <encoding>ISO-8859-1</encoding>

          </configuration>

      </plugin>

      ...

    </plugins>

  </build>

Packaging tests in jar

------------------------

Test classes do not packaging in jar by default.

To packing add to pom::

  <build>

    <plugins>

      ...

      <plugin>

        <!-- Packaging tests in jar -->

        <groupId>org.apache.maven.plugins</groupId>

        <artifactId>maven-jar-plugin</artifactId>

        <executions>

          <!-- Generates a jar file only with the test classes -->

          <execution>

            <goals>

              <goal>test-jar</goal>

            </goals>

            <configuration>

              <includes>

                <include>**/**</include>

              </includes>

            </configuration>

          </execution>

        </executions>

      </plugin> 

      ...

    </plugins>

  </build>

How to set a dependency with tests jar

-----------------------------------------

You can set a dependency with a test jar adding to

the declaration of the dependency the scope of

test and the type of "test-jar"::

  <dependency>

      <groupId>...</groupId>

      <artifactId>...</artifactId>

      <type>test-jar</type>

      <scope>test</scope>

  </dependency>

How use ant in maven

-------------------------

You can use ant embed in the pom of you project.

To do this use::

  <plugin>

    <artifactId>maven-antrun-plugin</artifactId>

    <version>1.7</version>

    <executions>

      <execution>

        <phase>generate-sources</phase>

        <configuration>

          <target>

            <echo>Hello world!</echo>

          </target>

        </configuration>

        <goals>

          <goal>run</goal>

        </goals>

      </execution>

    </executions>

  </plugin>

Fail when execute "mvn deploy" with "No connector available"

-------------------------------------------------------------

When execute a "mvn deploy" fail with the error::

  [INFO] ------------------------------------------------------------------------

  [ERROR] Failed to execute goal org.apache.maven.plugins:maven-deploy-plugin:2.7:deploy 

    (default-deploy) on project org.gvsig.desktop: Failed to deploy artifacts/metadata: 

    No connector available to access repository gvsig-repository (dav:https://devel.gvsig.org/m2repo/j2se) 

    of type default using the available factories WagonRepositoryConnectorFactory -> [Help 1]

  [ERROR] 

This happens to be configured the webdav wagon as an extension in the section "build"::

  ...

  <build>

    <extensions>

        <extension>

            <groupId>org.apache.maven.wagon</groupId>

            <artifactId>wagon-webdav-jackrabbit</artifactId>

            <version>1.0-beta-7</version>

        </extension>

    </extensions>

  ...

Fail when execute "mvn release: prepare" with "svn command failed... Could not authenticate"

------------------------------------------------------------------------------------------------

When running "mvn release: prepare" updates poms, compiles, and then

fails with the following error ::

  [INFO] ------------------------------------------------------------------------

  [ERROR] Failed to execute goal org.apache.maven.plugins:maven-release-plugin:2.1:prepare 

    (default-cli) on project org.gvsig.desktop: Unable to commit files

  [ERROR] Provider message:

  [ERROR] The svn command failed.

  [ERROR] Command output:

  [ERROR] svn: Commit failed (details follow):

  [ERROR] svn: MKACTIVITY of '/svn/gvsig-desktop/!svn/act/931a27bc-57e8-45d9-adcd-5a2cf54a7045': 

    authorization failed: Could not authenticate to server: rejected Basic challenge (https://devel.gvsig.org)

  [ERROR] -> [Help 1]

  [ERROR] 

  [ERROR]

Apparently maven in linux system use the svn of system and if you're not

authenticated when trying to access to the repository, svn fails.

This is solved by executing a commit from the command line on

some file of the project (only if you have not enabled the option 

"store-passwords = no" in $ HOME / .subversion / config). For example, you 

can add or remove at the end of "pom.xml" a blank line and then run 

from the command line ::

  svn ci -m "" pom.xml

Another option that works on Windows in declaring the user and password in the command:

mvn release:prepare -Dusername=[username] -Dpassword=[password]

====

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2013 gvSIG Association.

    This program is free software; you can redistribute it and/or

    modify it under the terms of the GNU General Public License

    as published by the Free Software Foundation; either version 3

    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program; if not, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

====

Put into this folder the resources needed by your test classes.

This folder is added to the Tests classpath, so you can load any resources 

through the ClassLoader.

By default, in this folder you can find an example of log4j configuration,

prepared to log messages through the console, so logging works when you

run your tests classes.

<?xml version="1.0" encoding="ISO-8859-1" ?>

<!--

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2012 gvSIG Association.

    This program is free software; you can redistribute it and/or

    modify it under the terms of the GNU General Public License

    as published by the Free Software Foundation; either version 2

    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program; if not, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

-->

<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- 

Log4J configuration file for unit tests execution.

 -->

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

	<!-- Appender configuration to show logging messages through the console -->

	<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">

		<layout class="org.apache.log4j.PatternLayout">

			<param name="ConversionPattern" value="%d{HH:mm:ss,SSS} %-5p [%c{2}.%M()]\n  %m%n" />

		</layout>

	</appender>

	<!-- 

	Activate logging messages of DEBUG level of higher only for the

	org.gvsig.tools packages.

	You can put full classes names or packages instead, to configure

	logging for all the classes and subpackages of the package.

	-->

	<category name="org.gvsig.tools">

		<priority value="DEBUG" />

	</category>

	<category name="org.gvsig.vectorediting">

		<priority value="DEBUG" />

	</category>

	<!-- 

	By default, show only logging messages of INFO level or higher, 

	through the previously configured CONSOLE appender. 

	-->

	<root>

		<priority value="INFO" />

		<appender-ref ref="CONSOLE" />

	</root>

</log4j:configuration>

====

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2013 gvSIG Association.

    This program is free software; you can redistribute it and/or

    modify it under the terms of the GNU General Public License

    as published by the Free Software Foundation; either version 3

    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program; if not, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

    at info AT gvsig.com, or visit our website www.gvsig.com.

====

Put into this folder the resources to be included in the plugin jar.

<!-- gvSIG. Desktop Geographic Information System. Copyright (C) 2007-2013 gvSIG

  Association. This program is free software; you can redistribute it and/or modify

  it under the terms of the GNU General Public License as published by the Free Software

  Foundation; either version 3 of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

  PURPOSE. See the GNU General Public License for more details. You should have received

  a copy of the GNU General Public License along with this program; if not, write to

  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,

  USA. For any additional information, do not hesitate to contact us at info AT gvsig.com,

  or visit our website www.gvsig.com. -->

<assembly>

  <id>gvsig-plugin-package</id>

  <formats>

    <format>zip</format>

  </formats>

  <baseDirectory>${project.artifactId}</baseDirectory>

  <includeBaseDirectory>true</includeBaseDirectory>

  <files>

    <file>

      <source>target/${project.artifactId}-${project.version}.jar</source>

      <outputDirectory>lib</outputDirectory>

    </file>

    <file>

      <source>target/package.info</source>

    </file>

  </files>

  <fileSets>

    <fileSet>

      <directory>src/main/resources-plugin</directory>

      <outputDirectory>.</outputDirectory>

    </fileSet>

  </fileSets>

  <dependencySets>

    <dependencySet>

      <useProjectArtifact>false</useProjectArtifact>

      <useTransitiveDependencies>false</useTransitiveDependencies>

      <outputDirectory>lib</outputDirectory>

      <includes>

        <include>org.gvsig:org.gvsig.vectorediting.lib.api</include>

        <include>org.gvsig:org.gvsig.vectorediting.swing.api</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.impl</include>

        <include>org.gvsig:org.gvsig.vectorediting.swing.impl</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.spi</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.point</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.circlecr</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.circle3p</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.polyline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.internalpolygon</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.line</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.arc</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.ellipse</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.regularpolygon</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.rectangle</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.spline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.explode</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.move</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.rotate</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.duplicate</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.scale</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.splitline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.simplify</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.multipoint</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.autopolygon</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.join</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.stretch</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.extendline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.split</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.smoothline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.trimline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.rectangularmatrix</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.polarmatrix</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.editvertex</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.remove</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.converttopolyline</include>

        <include>org.gvsig:org.gvsig.vectorediting.lib.prov.reversedirection</include>

      </includes>

    </dependencySet>

  </dependencySets>

</assembly>

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.app.project.documents.view.toc.actions;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.plugins.IExtension;

import org.gvsig.app.project.documents.view.toc.AbstractTocContextMenuAction;

import org.gvsig.app.project.documents.view.toc.ITocItem;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.vectorediting.app.mainplugin.EditingExtension;

public class StartEditingTocMenuEntry extends AbstractTocContextMenuAction {

    public static final String EXTENSION_POINT_NAME = "StartEditing";

    private IExtension ext = null;

    private static Logger logger =

        LoggerFactory.getLogger(StartEditingTocMenuEntry.class);

	public String getGroup() {

		return "vectorEditing";

	}

	public int getGroupOrder() {

		return 0;

	}

	public int getOrder() {

		return 0;

	}

	public String getText() {

		return PluginServices.getText(this, "start_editing");

	}

	public boolean isEnabled(ITocItem item, FLayer[] selectedItems) {

	    return ((EditingExtension)getExtension()).isEnabled("start-editing");

	}

   public boolean isVisible(ITocItem item, FLayer[] selectedItems) {

       return ((EditingExtension)getExtension()).isVisible("start-editing");

    }

	public void execute(ITocItem item, FLayer[] selItems) {

	       getExtension().execute("start-editing");

	}

    private IExtension getExtension() {

        if (ext == null) {

            ext = PluginServices.getExtension(EditingExtension.class);

        }

        return ext;

    }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.app.project.documents.view.toc.actions;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.plugins.IExtension;

import org.gvsig.app.project.documents.view.toc.AbstractTocContextMenuAction;

import org.gvsig.app.project.documents.view.toc.ITocItem;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.vectorediting.app.mainplugin.EditingExtension;

public class EndEditingTocMenuEntry extends AbstractTocContextMenuAction {

    public static final String EXTENSION_POINT_NAME = "EndEditing";

    private IExtension ext = null;

    private static Logger logger =

        LoggerFactory.getLogger(EndEditingTocMenuEntry.class);

	public String getGroup() {

		return "vectorEditing";

	}

	public int getGroupOrder() {

		return 0;

	}

	public int getOrder() {

		return 1;

	}

	public String getText() {

		return PluginServices.getText(this, "end_editing");

	}

	public boolean isEnabled(ITocItem item, FLayer[] selectedItems) {

	    return ((EditingExtension)getExtension()).isEnabled("end-editing");

	}

   public boolean isVisible(ITocItem item, FLayer[] selectedItems) {

        return ((EditingExtension)getExtension()).isVisible("end-editing");

    }

	public void execute(ITocItem item, FLayer[] selItems) {

	       getExtension().execute("end-editing");

	}

    private IExtension getExtension() {

        if (ext == null) {

            ext = PluginServices.getExtension(EditingExtension.class);

        }

        return ext;

    }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2014 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.vectorediting.app.mainplugin;

import org.gvsig.andami.plugins.Extension;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.ApplicationManager;

import org.gvsig.app.project.documents.view.ViewDocument;

import org.gvsig.app.project.documents.view.gui.IView;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.fmap.mapcontext.layers.vectorial.FLyrVect;

import org.gvsig.vectorediting.swing.api.EditingContext;

import org.gvsig.vectorediting.swing.api.EditingSwingLocator;

import org.gvsig.vectorediting.swing.api.EditingSwingManager;

public class ServiceExtension extends Extension {

    public void initialize() {

    }

    public void execute(String actionCommand) {

        IView view = getActiveView();

        EditingSwingManager swingManager =

            EditingSwingLocator.getSwingManager();

        if (view != null) {

            EditingContext editingContext =

                swingManager.getEditingContext(view.getMapControl());

            editingContext.activateService(actionCommand);

        }

    }

    public boolean isEnabled() {

        return this.isVisible();

    }

    @Override

    public boolean isEnabled(String action) {

        IView view = getActiveView();

        FLyrVect activeLayer = getActiveLayer(view);

        if ((view != null) && (activeLayer != null) && activeLayer.isEditing() && action!=null) {

            EditingSwingManager swingManager =

                EditingSwingLocator.getSwingManager();

            EditingContext editingContext =

                swingManager.getEditingContext(view.getMapControl());

            return editingContext.isServiceCompatible(action);

        }

        return false;

    }

    public boolean isVisible() {

        IView view = getActiveView();

        FLyrVect activeLayer = getActiveLayer(view);

        return ((view != null) && (activeLayer != null) && activeLayer

            .isEditing());

    }

    @Override

    public boolean isVisible(String action) {

        return this.isVisible();

    }

    @Override

    public boolean canQueryByAction() {

        return true;

    }

    private IView getActiveView() {

        ApplicationManager application = ApplicationLocator.getManager();

        IView view = (IView) application.getActiveComponent(ViewDocument.class);

        return view;

    }

    private FLyrVect getActiveLayer(IView view) {

        if (view != null) {

            ViewDocument viewDocument = view.getViewDocument();

            FLayer[] actives =

                viewDocument.getMapContext().getLayers().getActives();

            if ((actives.length == 1) && (actives[0] instanceof FLyrVect)) {

                return (FLyrVect) actives[0];

            }

        }

        return null;

    }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2014 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.vectorediting.app.mainplugin;

import java.io.File;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

import java.util.function.Predicate;

import javax.swing.JOptionPane;

import org.apache.commons.io.FileUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.IconThemeHelper;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.PluginsLocator;

import org.gvsig.andami.actioninfo.ActionInfo;

import org.gvsig.andami.plugins.Extension;

import org.gvsig.andami.plugins.IExtension;

import org.gvsig.andami.plugins.status.IExtensionStatus;

import org.gvsig.andami.plugins.status.IUnsavedData;

import org.gvsig.andami.plugins.status.UnsavedData;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.ApplicationManager;

import org.gvsig.app.project.Project;

import org.gvsig.app.project.documents.Document;

import org.gvsig.app.project.documents.view.ViewDocument;

import org.gvsig.app.project.documents.view.ViewManager;

import org.gvsig.app.project.documents.view.gui.DefaultViewPanel;

import org.gvsig.app.project.documents.view.gui.IView;

import org.gvsig.app.project.documents.view.toc.actions.EndEditingTocMenuEntry;

import org.gvsig.app.project.documents.view.toc.actions.StartEditingTocMenuEntry;

import org.gvsig.app.project.documents.view.toolListeners.StatusBarListener;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.MapContextLocator;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.fmap.mapcontext.layers.FLayers;

import org.gvsig.fmap.mapcontext.layers.vectorial.FLyrVect;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.fmap.mapcontext.rendering.symbols.SymbolException;

import org.gvsig.fmap.mapcontext.rendering.symbols.SymbolManager;

import org.gvsig.fmap.mapcontrol.MapControl;

import org.gvsig.fmap.mapcontrol.MapControlCreationListener;

import org.gvsig.fmap.mapcontrol.MapControlLocator;

import org.gvsig.fmap.mapcontrol.tools.Behavior.Behavior;

import org.gvsig.fmap.mapcontrol.tools.Behavior.MouseMovementBehavior;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.extensionpoint.ExtensionPoint;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.observer.Notification;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.swing.api.windowmanager.WindowManager.MODE;

import org.gvsig.utils.swing.threads.IMonitorableTask;

import org.gvsig.vectorediting.lib.spi.EditingProviderLocator;

import org.gvsig.vectorediting.lib.spi.EditingProviderManager;

import org.gvsig.vectorediting.swing.api.EditingContext;

import org.gvsig.vectorediting.swing.api.EditingSwingLocator;

import org.gvsig.vectorediting.swing.api.EditingSwingManager;

public class EditingExtension extends Extension implements Observer {

  private static final Logger LOGGER = LoggerFactory.getLogger(EditingExtension.class);

  @Override

  public void execute(String actionCommand) {

    ApplicationManager application = ApplicationLocator.getManager();

    IView view = getActiveView();

    EditingSwingManager swingManager = EditingSwingLocator.getSwingManager();

    if (view != null) {

      MapControl mapControl = view.getMapControl();

      EditingContext editingContext = swingManager.getEditingContext(mapControl);

      if ("start-editing".equals(actionCommand)) {

        List<FLyrVect> reprojectedLayers = getActiveLayers(

                view,

                (FLyrVect layer) -> canBeEdited(layer) && 

                        !mapControl.getProjection().equals(layer.getProjection())

        );

        if (!reprojectedLayers.isEmpty()) {

          String msg = "_The_layer_is_reproyected_on_the_fly"

                  + "_Not_all_editing_tools_work_properly"

                  + "_When_you_finish_editing"

                  + "_will_only_export_the_changes_to_another_layer";

          application.messageDialog(msg, "_Warning", JOptionPane.WARNING_MESSAGE);

        } else {

          List<FLyrVect> nonWritableLayers = getActiveLayers(

                  view,

                  (FLyrVect layer) -> canBeEdited(layer) && !isWritable(layer)

          );

          if (!nonWritableLayers.isEmpty()) {

            String msg = "_The_layer_can_not_be_written"

                    + "_When_you_finish_editing"

                    + "_will_only_export_the_changes_to_another_layer";

            application.messageDialog(msg, "_Warning", JOptionPane.WARNING_MESSAGE);

          }

        }

        List<FLyrVect> activeLayers = getActiveLayers(

                view,

                (FLyrVect layer) -> canBeEdited(layer)

        );

        for (FLyrVect layer : activeLayers) {

          editingContext.beginEdition(layer);

          editingContext.addObserver(this);

        }

        ApplicationLocator.getManager().refreshMenusAndToolBars();

      } else if ("end-editing".equals(actionCommand)) {

        List<FLyrVect> activeLayers = getActiveLayers(

                view,

                (FLyrVect layer) -> layer.isEditing()

        );

        for (FLyrVect layer : activeLayers) {

          editingContext.endEdition(layer);

        }

        ApplicationLocator.getManager().refreshMenusAndToolBars();

      }

    }

  }

  @Override

  public void initialize() {

    registerIcons();

    // Disable default view panel console. Uses editing context console.

    DefaultViewPanel.setDisableConsole(true);

    // Adding TOC menu entry

    ExtensionPoint exPoint = ToolsLocator.getExtensionPointManager().add(

            "View_TocActions", "");

    exPoint.append(

            StartEditingTocMenuEntry.EXTENSION_POINT_NAME,

            "TOC popup menu to start vector layer's editing",

            new StartEditingTocMenuEntry());

    exPoint.append(

            EndEditingTocMenuEntry.EXTENSION_POINT_NAME,

            "TOC popup menu to end vector layer's editing",

            new EndEditingTocMenuEntry());

  }

  private void registerIcons() {

    IconThemeHelper.registerIcon("vectorediting", "vector-editing", this);

  }

  @Override

  public void postInitialize() {

    super.postInitialize();

    registerSymbols();

    MapControlLocator.getMapControlManager().addMapControlCreationListener(new MapControlCreationListener() {

      @Override

      public MapControl mapControlCreated(MapControl mapControl) {

        EditingContext editingContext = EditingSwingLocator.getSwingManager().getEditingContext(mapControl);

        StatusBarListener sbl = new StatusBarListener(mapControl);

        editingContext.setDefaultBehaviors(new Behavior[]{new MouseMovementBehavior(sbl)});

        editingContext.addObserver(EditingExtension.this);

        ApplicationLocator.getManager().refreshMenusAndToolBars();

        return mapControl;

      }

    });

  }

  /**

   * Register all symbols in the plugin symbols folder in the providerManager.

   * The description of the symbols must be unique because the key used for

   * registration is the proper description of the symbol.

   *

   */

  private void registerSymbols() {

    EditingProviderManager providerManager = EditingProviderLocator.getProviderManager();

    SymbolManager symbolManager = MapContextLocator.getSymbolManager();

    File symbolsFolder = FileUtils.getFile(getPlugin().getPluginDirectory(), "symbols", "editing");

    ISymbol[] symbols = null;

    try {

      symbols = symbolManager.loadSymbols(symbolsFolder);

    } catch (SymbolException e) {

      LOGGER.warn("No symbols loaded from " + symbolsFolder.getAbsolutePath(), e);

    }

    if (symbols != null) {

      for (ISymbol symbol : symbols) {

        String description = symbol.getDescription();

        providerManager.registerSymbol(description, symbol);

      }

    }

  }

  @Override

  public boolean isEnabled() {

    return true;

  }

  @Override

  public boolean isVisible() {

    return true;

  }

  @Override

  public boolean isVisible(String action) {

    IView view = getActiveView();

    if( view == null ) {

      return false;

    }

    if ("start-editing".equals(action)) {

      List<FLyrVect> activeLayers = getActiveLayers(view, (FLyrVect layer) -> !layer.isEditing());

      return !activeLayers.isEmpty();

    } else {

      List<FLyrVect> activeLayers = getActiveLayers(view, (FLyrVect layer) -> layer.isEditing());

      return !activeLayers.isEmpty();

    }

  }

  @Override

  public boolean isEnabled(String action) {

    IView view = getActiveView();

    if( view == null ) {

      return false;

    }

    if ("start-editing".equals(action)) {

      List<FLyrVect> activeLayers = getActiveLayers(view, (FLyrVect layer) -> canBeEdited(layer));

      return !activeLayers.isEmpty();

    } else if ("end-editing".equals(action)) {

      List<FLyrVect> activeLayers = getActiveLayers(view, (FLyrVect layer) -> layer.isEditing());

      return !activeLayers.isEmpty();

    }

    return false;

  }

  @Override

  public boolean canQueryByAction() {

    return true;

  }

  private IView getActiveView() {

    ApplicationManager application = ApplicationLocator.getManager();

    IView view = (IView) application.getActiveComponent(ViewDocument.class);

    return view;

  }

  private boolean isWritable(FLyrVect layer) {

    if (layer != null && layer.isAvailable()) {

      return layer.getFeatureStore().allowWrite();

    }

    return false;

  }

  private boolean canBeEdited(FLyrVect layer) {

    if (layer != null && layer.isAvailable()) {

      boolean isNotTransformed

              = layer.getFeatureStore().getTransforms().isEmpty();

      return isNotTransformed && !layer.isEditing();

    }

    return false;

  }

//  private FLyrVect getActiveLayer(IView vista) {

//    if (vista != null) {

//      ViewDocument viewDocument = vista.getViewDocument();

//      FLayer[] actives

//              = viewDocument.getMapContext().getLayers().getActives();

//

//      if ((actives.length == 1) && (actives[0] instanceof FLyrVect)) {

//        return (FLyrVect) actives[0];

//      }

//    }

//    return null;

//  }

  private List<FLyrVect> getActiveLayers(IView view, Predicate<FLyrVect> valid) {

    if (view == null) {

      return Collections.EMPTY_LIST;

    }

    List<FLyrVect> layers = new ArrayList<>();

    ViewDocument viewDocument = view.getViewDocument();

    FLayer[] actives = viewDocument.getMapContext().getLayers().getActives();

    for (FLayer layer : actives) {

      if (layer instanceof FLyrVect && valid.test((FLyrVect) layer)) {

        layers.add((FLyrVect) layer);

      }

    }

    return layers;

  }

  @Override

  public void update(Observable observable, Object notification) {

    if (notification instanceof Notification) {

      ApplicationManager appManager = ApplicationLocator.getManager();

      Notification n = (Notification) notification;

      if (n.isOfType(EditingContext.CHANGE_SELECTED_TOOL_NOTIFICATION)) {

        String name = (String) n.getValue();

        LOGGER.trace("Changed selected tool to '{}'", name);

        PluginServices.getMainFrame().setSelectedTool(name);

        appManager.refreshMenusAndToolBars();

      } else if (n.isOfType(EditingContext.EXPORT_LAYER_NOTIFICATION)) {

        exportLayer((FLyrVect) (n.getValue()));

      } else if (n.isOfType(EditingContext.REFRESH_TOOLS_NOTIFICATION)) {

        appManager.refreshMenusAndToolBars();

      }

    }

  }

  private void exportLayer(FLyrVect layer) {

    ApplicationManager appManager = ApplicationLocator.getManager();

    I18nManager i18nManager = ToolsLocator.getI18nManager();

    ActionInfo action = PluginsLocator.getActionInfoManager().getAction("layer-exportto");

    action.execute(new Object[]{layer, MODE.toInteger(MODE.DIALOG)});

    String msg = "_Do_you_want_to_finish_editing_If_not_exported_the_data_the_changes_will_be_lost";

    if (appManager.confirmDialog(

            i18nManager.getTranslation(msg),

            i18nManager.getTranslation("end_editing"),

            JOptionPane.YES_NO_OPTION,

            JOptionPane.QUESTION_MESSAGE) == JOptionPane.YES_OPTION) {

      try {

        layer.getFeatureStore().cancelEditing();

      } catch (Exception e) {

        LOGGER.warn("Can't abort editing of layer '" + layer.getName() + "'.", e);

        msg = "_Cant_finish_editing_See_the_error_log_for_more_information";

        appManager.messageDialog(msg, "_Warning", JOptionPane.WARNING_MESSAGE);

      }

    }

  }

  private List<FLyrVect> getEditedLayers() {

    ApplicationManager application = ApplicationLocator.getManager();

    List<FLyrVect> editedLayers = new ArrayList<>();

    Project project = application.getCurrentProject();

    for (Document document : project.getDocuments(ViewManager.TYPENAME)) {

      ViewDocument view = (ViewDocument) document;

      MapContext mapContext = view.getMapContext();

      if (mapContext != null) {

        FLayers layers = mapContext.getLayers();

        for (int j = 0; j < layers.getLayersCount(); j++) {

          FLayer lyr = layers.getLayer(j);

          if (lyr instanceof FLyrVect) {

            FLyrVect layerVect = (FLyrVect) lyr;

            if (layerVect.isEditing()) {

              editedLayers.add(layerVect);

            }

          }

        }

      }

    }

    return editedLayers;

  }

  private List<IUnsavedData> getUnsavedData(List<FLyrVect> editedLayers) {

    List<IUnsavedData> unsavedData = new ArrayList<>();

    for (FLyrVect editedLayer : editedLayers) {

      IUnsavedData unsavedDataLayer = new UnsavedLayer(this, editedLayer);

      unsavedData.add(unsavedDataLayer);

    }

    return unsavedData;

  }

  private static class UnsavedLayer extends UnsavedData {

    private final FLyrVect layer;

    public UnsavedLayer(IExtension extension, FLyrVect layer) {

      super(extension);

      this.layer = layer;

    }

    @Override

    public String getDescription() {

      return layer.getName();

    }

    @Override

    public String getResourceName() {

      return layer.getFeatureStore().getFullName();

    }

    @Override

    public boolean saveData() {

      FeatureStore featureStore = layer.getFeatureStore();

      if (featureStore.isEditing()) {

        try {

          featureStore.finishEditing();

          return true;

        } catch (DataException e) {

          throw new RuntimeException(e);

        }

      }

      return true;

    }

  }

  @Override

  public IExtensionStatus getStatus() {

    List<FLyrVect> editedLayers = getEditedLayers();

    final List<IUnsavedData> unsavedData = getUnsavedData(editedLayers);

    return new IExtensionStatus() {

      @Override

      public boolean hasUnsavedData() {

        if (unsavedData == null) {

          return false;

        }

        return !unsavedData.isEmpty();

      }

      @Override

      public boolean hasRunningProcesses() {

        return false;

      }

      @Override

      public IUnsavedData[] getUnsavedData() {

        if (unsavedData == null) {

          return null;

        }

        return unsavedData.toArray(new IUnsavedData[0]);

      }

      @Override

      public IMonitorableTask[] getRunningProcesses() {

        return null;

      }

    };

  }

}

start_editing = Start editing

end_editing = End editing

insert_point = Insert point

insert_multipoint = Insert MultiPoint

insert_line = Insert line

insert_arc = Insert arc

insert_circle_cr=Insert circle (center & radius)

insert_circumference_cr=Insert circumference (center & radius)

insert_circle_3p = Insert circle (three point)

insert_circumference_3p = Insert circumference (three points)

insert_ellipse = Insert ellipse

insert_filled_ellipse = Insert filled ellipse

insert_polyline = Insert polyline

insert_polygon = Insert polygon

insert_regular_polygon = Insert regular polygon

insert_filled_regular_polygon = Insert filled regular polygon

insert_rectangle = Insert rectangle

insert_filled_rectangle = Insert filled rectangle

insert_spline= Insert spline curve

insert_filled_spline = Insert filled spline

insert_rectangular_matrix = Rectangular matrix of geometries

insert_polar_matrix = Polar matrix of geometries

modify_internal_polygon = Internal polygon

modify_explode_geometry = Explode geometry

modify_move = Move geometry

modify_rotate = Rotate geometry

modify_duplicate = Duplicate geometry

modify_split_line = Split line open by a point

modify_split = Split geometry

modify_scale = Scale geometry

modify_simplify = Simplify geometry

insert_autopolygon = Insert autopolygon

modify_join = Join geometries

modify_stretch = Stretch geometry

modify_extend_line = Extend line to object

modify_trim_line = Trim line by object

modify_edit_vertex = Edit vertex

modify_convert_to_polyline= Convert to polyline

modify_reverse_direction=Reverse direction

uniqueselection = Select only one geometry

selectvertex = Select a vertex

new_position = New position

new_position_or_z_value = New position or Z value

insert_vertex = Insertr vertex

remove_vertex = Remove vertex

selection=Selection

invalid_option=Invalid option

center=Center

radius=Radius

save_changes_performed=Save changed performed

discard= Discard

discard_and_loose_changes= Discard changes and loose changes

continue= Continue

do_not_save_yet_stay_in_editing_mode= Don't save changes and continue editing

indicate_new_point= Indicate new point

arc_mode = Arc mode

line_mode = Line mode

select_new_tool= Select a new tool

draw_geometry_to_interal_polygon= Select tool to draw a internal polygon

draw_geometry_to_autopolygon = Select tool to draw an autopolygon

draw_geometry_to_split = Select tool to split selected geometries

draw_geometry_to_select_vertex = Select a polygonal tool to select vertex

save = Save

discard = Discard

continue = Continue