gvSIG projects pool

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <parent>

    <groupId>org.gvsig</groupId>

    <artifactId>org.gvsig.topology</artifactId>

    <version>1.0.46</version>

  </parent>

  <artifactId>org.gvsig.topology.lib</artifactId>

  <packaging>pom</packaging>

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

  <modules>

  	<module>org.gvsig.topology.lib.api</module>

  	<module>org.gvsig.topology.lib.impl</module>

  </modules>

</project>

org.gvsig.topology.lib.api.TopologyLibrary

package org.gvsig.topology.lib.api;

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

/**

 *

 * @author jjdelcerro

 */

public class PerformOperationException extends DataException {

    public PerformOperationException(String msg) {

        super("_CancelOperationException", msg, 0);

    }

}

/**

 * 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.topology.lib.api;

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

/**

 *

 * @author jjdelcerro

 */

public interface TopologyServices {

    public FeatureStore getFeatureStore(TopologyDataSet dataSet);

}

/**

 * 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.topology.lib.api;

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

import org.gvsig.fmap.geom.Geometry;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyReportLine {

    public TopologyRule getRule();

    public TopologyDataSet getDataSet1();

    public TopologyDataSet getDataSet2();

    public Geometry getGeometry();

    public Geometry getError();

    public FeatureReference getFeature1();

    public FeatureReference getFeature2();

    public int getPrimitiveNumber1();

    public int getPrimitiveNumber2();

    public boolean isException();

    public String getDescription();

    public String getData();

}

/**

 * 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.topology.lib.api;

import org.gvsig.expressionevaluator.Expression;

import org.gvsig.fmap.dal.DataStore;

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

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

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

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

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.SpatialIndex;

import org.gvsig.tools.util.PropertiesSupport;

import org.gvsig.tools.visitor.VisitCanceledException;

import org.gvsig.tools.visitor.Visitor;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyDataSet extends PropertiesSupport, SerializableJSON {

    public static interface Operation {

        public void run() throws DataException;

    }

    public void setName(String name);

    public String getName();

    public DataStore getStore();

    public FeatureStore getFeatureStore();

    public boolean isThisStore(FeatureStore featureStore);

    public int getGeometryType() ;

    public void accept(Visitor visitor) throws VisitCanceledException;

    public void edit() throws DataException;

    public void finishEditing() throws DataException;

    public EditableFeature createNewFeature() throws DataException;

    public void delete(FeatureReference feature) throws DataException;

    public void delete(Feature feature) throws DataException;

    public void insert(EditableFeature feature) throws DataException;

    public void update(EditableFeature feature) throws DataException;

    public long getSize();

    public SpatialIndex getSpatialIndex();

    /**

     * @param geom

     * @return 

     * @deprecated  use queryFeatures or queryReferences

     */

    public Iterable<FeatureReference> query(Geometry geom);

    public Iterable<Feature> queryFeatures(Geometry geom);

    public Iterable<FeatureReference> queryReferences(Geometry geom);

    public Feature findFirst(Expression expression);

    public void restart();

}

package org.gvsig.topology.lib.api;

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

/**

 *

 * @author jjdelcerro

 */

public class CancelOperationException extends DataException {

    public CancelOperationException(String msg) {

        super("_CancelOperationException", msg, 0);

    }

}

/**

 * 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.topology.lib.api;

import java.util.Collection;

import org.gvsig.fmap.dal.DataStore;

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

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyPlan extends SerializableJSON {

    public String getName();

    public void setName(String name);

    public double getTolerance();

    public void setTolerance(double tolerance);

    public void clear();

    public void setTopologyServices(TopologyServices services);

    public TopologyServices getTopologyServices();

    public SimpleTaskStatus getTaskStatus();

    public void execute();

    public TopologyDataSet addDataSet(String name, DataStore store);

    public TopologyDataSet addDataSet(TopologyDataSet dataSet);

    public void removeDataSet(TopologyDataSet dataSet);

    public boolean containsDataSet(String name);

    public TopologyDataSet getDataSet(String name);

    public Collection<TopologyDataSet> getDataSets();

    public Collection<TopologyDataSet> getSecondaryDataSets(TopologyRuleFactory ruleFactory);

    public TopologyRule addRule(String id, String dataSet1, String dataSet2, double tolerance);

    public TopologyRule addRule(TopologyRule rule);

    public void removeRule(TopologyRule rule);

    public Collection<TopologyRule> getRules();

    public TopologyReport getReport();

}

package org.gvsig.topology.lib.api;

import java.util.List;

import org.gvsig.tools.swing.api.ChangeListenerSupport;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyReportLineSet extends ChangeListenerSupport {

    public List<TopologyReportLine> getLines();

    public boolean isComplete();

    public int size();

    public TopologyReportLine get(int index);

}

/**

 * 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.topology.lib.api;

import java.util.List;

import org.gvsig.tools.dynobject.DynObject;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyRuleFactory {

    public String getId();

    public String getName();

    public String getDescription();

    public List<Integer> getGeometryTypeDataSet1();

    public List<Integer> getGeometryTypeDataSet2();

    public DynObject createRuleParameters();

    public TopologyRule createRule(TopologyPlan plan, String dataSet1, String dataSet2, double tolerance);

    public boolean hasRuleParameters();

    public boolean hasSecondaryDataSet();

    public boolean canApplyToDataSet(TopologyDataSet dataSet);

    public boolean canApplyToSecondaryDataSet(TopologyDataSet dataSet);

}

package org.gvsig.topology.lib.api;

import org.json.JSONObject;

/**

 *

 * @author jjdelcerro

 */

public interface SerializableJSON {

    public JSONObject toJSON();

    public void fromJSON(JSONObject json);

    public void fromJSON(String json);

}

/**

 * 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.topology.lib.api;

import org.gvsig.tools.locator.AbstractLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

@SuppressWarnings("rawtypes")

public class TopologyLocator extends AbstractLocator {

	private static final String LOCATOR_NAME = "TopologyLocator";

	public static final String TOPOLOGY_MANAGER_NAME =

			"org.gvsig.topology.manager";

	private static final String TOPOLOGY_MANAGER_DESCRIPTION =

			"Topology Manager of gvSIG";

	private static final TopologyLocator instance = new TopologyLocator();

	private TopologyLocator() {

	}

	/**

	 * Return the singleton instance.

	 * 

	 * @return the singleton instance

	 */

	public static TopologyLocator getInstance() {

		return instance;

	}

        @Override

	public String getLocatorName() {

		return LOCATOR_NAME;

	}

	/**

	 * Return a reference to TopologyManager.

	 * 

	 * @return a reference to TopologyManager

	 * @throws LocatorException

	 *             if there is no access to the class or the class cannot be

	 *             instantiated

	 * @see Locator#get(String)

	 */

	public static TopologyManager getTopologyManager()

			throws LocatorException {

		return (TopologyManager) getInstance().get(TOPOLOGY_MANAGER_NAME);

	}

	/**

	 * Registers the Class implementing the TopologyManager interface.

	 * 

	 * @param clazz

	 *            implementing the TopologyManager interface

	 */

	public static void registerTopologyManager(Class clazz) {

		getInstance().register(TOPOLOGY_MANAGER_NAME,

				TOPOLOGY_MANAGER_DESCRIPTION, clazz);

	}

	public static void registerDefaultTopologyManager(Class clazz) {

		getInstance().registerDefault(TOPOLOGY_MANAGER_NAME,

				TOPOLOGY_MANAGER_DESCRIPTION, clazz);

	}

}

/**

 * 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.topology.lib.api;

import org.gvsig.fmap.dal.DALLibrary;

import org.gvsig.fmap.geom.GeometryLibrary;

import org.gvsig.tools.ToolsLibrary;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

/**

 *

 * @author jjdelcerro

 */

public class TopologyLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        super.doRegistration();

        registerAsAPI(TopologyLibrary.class);

        this.require(ToolsLibrary.class);

        this.require(DALLibrary.class);

        this.require(GeometryLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

    }

}

/**

 * 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.topology.lib.api;

import org.gvsig.tools.dynobject.DynObject;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyRuleAction {

    public String getId();

    public String getName();

    public String getShortDescription();

    public TopologyRuleFactory getRuleFactory();

    public boolean hasParameters();

    public DynObject createParameters();

    public void execute(

            TopologyRule rule,

            TopologyReportLine line, 

            DynObject parameters

        ) throws ExecuteTopologyRuleActionException;

}

/**

 * 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.topology.lib.api;

public class ExecuteTopologyRuleActionException extends RuntimeException {

    public ExecuteTopologyRuleActionException(Exception ex) {

        this.initCause(ex);

    }

}

/**

 * 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.topology.lib.api;

import java.util.List;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyRule extends SerializableJSON {

    public void execute(SimpleTaskStatus taskStatus, TopologyReport report) throws ExecuteTopologyRuleException;

    public String getName();

    public String getId();

    public TopologyRuleFactory getFactory();

    public TopologyDataSet getDataSet1();

    public TopologyDataSet getDataSet2();

    public double getTolerance();

    public List<TopologyRuleAction> getActions();

    public TopologyRuleAction getAction(String name);

    public long getSteps();

    public void setParameters(DynObject parameters);

    public DynObject getParameters();

}

/*

 * To change this license header, choose License Headers in Project Properties.

 * To change this template file, choose Tools | Templates

 * and open the template in the editor.

 */

package org.gvsig.topology.lib.api;

/**

 *

 * @author jjdelcerro

 */

public class ExecuteTopologyRuleException extends RuntimeException {

    public ExecuteTopologyRuleException(Exception ex) {

        this.initCause(ex);

    }

}

/**

 * 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.topology.lib.api;

import java.util.List;

import org.gvsig.fmap.dal.DataStore;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyManager {

    public TopologyPlan createTopologyPlan();

    public List<TopologyRuleFactory> getRuleFactories();

    public TopologyRuleFactory getRulefactory(String id);

    public List<TopologyRuleFactory> getRuleFactories(TopologyDataSet dataSet);

    public void addRuleFactories(TopologyRuleFactory factory);

    public TopologyDataSet createDataSet(String name, DataStore store);

    public void setDefaultServices(TopologyServices services);

    public TopologyServices getDefaultServices();

}

/**

 * 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.topology.lib.api;

import java.util.List;

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

import org.gvsig.fmap.geom.Geometry;

/**

 *

 * @author jjdelcerro

 */

public interface TopologyReport extends TopologyReportLineSet {

    public static String RULE_ID = "RULE_ID";

    public static String IS_ERROR = "IS_ERROR";

    public static String IS_EXCEPTION = "IS_EXCEPTION";

    public static String GEOMETRY = "GEOMETRY";

    public TopologyReportLine addLine(

            TopologyRule rule,

            TopologyDataSet dataSet1,

            TopologyDataSet dataSet2,

            Geometry geometry,

            Geometry error,

            FeatureReference feature1,

            FeatureReference feature2,

            boolean exception,

            String description

        );

    public TopologyReportLine addLine(

            TopologyRule rule,

            TopologyDataSet dataSet1,

            TopologyDataSet dataSet2,

            Geometry geometry,

            Geometry error,

            FeatureReference feature1,

            FeatureReference feature2,

            int primitive1,

            int primitive2,

            boolean exception,

            String description,

            String data

        );

    public void removeAllLines();

    @Override

    public List<TopologyReportLine> getLines();

    public List<TopologyReportLine> getLines(String filter);

    public TopologyReportLineSet getLineSet(String filter);

}

/**

 * 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.topology.lib.spi;

import java.net.URL;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.topology.lib.api.TopologyLocator;

import org.gvsig.topology.lib.api.TopologyRuleAction;

import org.gvsig.topology.lib.api.TopologyRuleFactory;

import org.json.JSONObject;

/**

 *

 * @author jjdelcerro

 */

public abstract class AbstractTopologyRuleAction implements TopologyRuleAction {

    private final String idAction;

    private final String idRule;

    private String name;

    private String shortDescription;

    protected AbstractTopologyRuleAction(

            String idRule,

            String idAction,

            String name,

            String shortDescription

        ) {

        this.idRule = idRule;

        this.idAction = idAction;

        this.name = name;

        this.shortDescription = shortDescription;

        this.load_from_resource();

    }

    @Override

    public String getId() {

        return this.idAction;

    }

    @Override

    public String getName() {

        return this.name;

    }

    @Override

    public String getShortDescription() {

        return this.shortDescription;

    }

    @Override

    public TopologyRuleFactory getRuleFactory() {

        TopologyRuleFactory f = TopologyLocator.getTopologyManager().getRulefactory(this.idRule);

        return f;

    }

    @Override

    public boolean hasParameters() {

        return false;

    }

    @Override

    public DynObject createParameters() {

        return null;

    }

    private void load_from_resource() {

        URL url = RuleResourceLoaderUtils.getRuleURL(this.idRule);

        JSONObject rule = RuleResourceLoaderUtils.getRule(url);

        load_from_resource(url, rule);

    }

    protected void load_from_resource(URL jsonUrl, JSONObject rule) {

        if( rule == null ) {

            return;

        }

        JSONObject action = RuleResourceLoaderUtils.getAction(rule, this.idAction);

        if( action.has("name") ) {

            this.name = action.getString("name");

        }

        if( action.has("description") ) {

            this.shortDescription = RuleResourceLoaderUtils.getDescription(jsonUrl, action);

        }

    }

}

/*

 * To change this license header, choose License Headers in Project Properties.

 * To change this template file, choose Tools | Templates

 * and open the template in the editor.

 */

package org.gvsig.topology.lib.spi;

import java.io.File;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.util.List;

import java.util.Locale;

import org.apache.commons.io.FilenameUtils;

import org.apache.commons.io.IOUtils;

import org.apache.commons.lang3.StringUtils;

import org.json.JSONArray;

import org.json.JSONObject;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 *

 * @author jjdelcerro

 */

@SuppressWarnings("UseSpecificCatch")

public class RuleResourceLoaderUtils {

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

    public static URL getRuleURL(String idRule) {

        String lang = Locale.getDefault().getLanguage();

        URL url = RuleResourceLoaderUtils.class.getResource("/org/gvsig/topology/rules/"+lang+"/"+idRule+".json");

        if( url == null ) {

            url = RuleResourceLoaderUtils.class.getResource("/org/gvsig/topology/rules/en/"+idRule+".json");

            if( url == null ) {

                return null;

            }

        }

        return url;

    }

    public static JSONObject getRule(URL url) {

        if( url == null ) {

            return null;

        }

        InputStream is = null;

        JSONObject json;

        try {

            is = url.openStream();

            List<String> lines = IOUtils.readLines(is);

            json = new JSONObject(StringUtils.join(lines,  "\n"));

        } catch (Exception ex) {

            LOGGER.warn("Can't load resource from json file '"+url.toString()+"'.", ex);

            return null;

        } finally {

            IOUtils.closeQuietly(is);

        }

        return json;

    }

    public static JSONObject getRule(String idRuleOrPathname) {

        if( idRuleOrPathname==null ) {

            return null;

        }

        if( idRuleOrPathname.endsWith(".json") ) {

            // Asumimos que es una ruta al fichero json.

            return getRule(new File(idRuleOrPathname));

        }

        // Asumimos que es un ID de regla

        URL url = getRuleURL(idRuleOrPathname);

        if( url == null ) {

            return null;

        }

        return getRule(url);

    }

    public static JSONObject getRule(File jsonfile) {

        if( jsonfile == null || !jsonfile.exists() ) {

            return null;

        }

        try {

            return getRule(jsonfile.toURI().toURL());

        } catch (MalformedURLException ex) {

            LOGGER.warn("Can't load resource from json file '"+jsonfile.toString()+"'.", ex);

            return null;

        }

    }

    public static String getDescription(URL jsonUrl, JSONObject json) {

        String description = null;

        if( json.has("description") ) {

            Object x = json.get("description");

            if( x instanceof String ) {

                description = (String) x;

            } else if( x instanceof JSONArray ) {

                StringBuilder builder = new StringBuilder();

                for (int i = 0; i < ((JSONArray)x).length(); i++) {

                    if( i>0 ) {

                        builder.append(" ");

                    }

                    builder.append(((JSONArray)x).getString(i));

                }

                description = builder.toString();

            } else {

                description = x.toString();

            }

            if( description.contains("@@@") ) {

                description = StringUtils.replace(

                        description, 

                        "@@@", 

                        FilenameUtils.removeExtension(jsonUrl.toString())

                );

            }

        }

        return description;

    }

    public static JSONObject getAction(JSONObject rule, String idAction) {

        if( !rule.has("actions") ) {

            return null;

        }

        if( !rule.getJSONObject("actions").has(idAction) ) {

            return null;

        }

        JSONObject action = rule.getJSONObject("actions").getJSONObject(idAction);

        return action;

    }

}

/**

 * 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.topology.lib.spi;

import java.util.ArrayList;

import java.util.Collections;

import java.util.List;

import org.apache.commons.lang3.StringUtils;

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

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.tools.visitor.VisitCanceledException;

import org.gvsig.tools.visitor.Visitor;

import org.gvsig.topology.lib.api.TopologyDataSet;

import org.gvsig.topology.lib.api.TopologyPlan;

import org.gvsig.topology.lib.api.TopologyReport;

import org.gvsig.topology.lib.api.TopologyRule;

import org.gvsig.topology.lib.api.TopologyRuleAction;

import org.gvsig.topology.lib.api.TopologyRuleFactory;

import org.json.JSONObject;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 *

 * @author jjdelcerro

 */

public abstract class AbstractTopologyRule implements TopologyRule {

    protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractTopologyRule.class);

    private final TopologyPlan plan;

    private final TopologyRuleFactory factory;

    private double tolerance;

    private String dataSet1;

    private String dataSet2;

    protected List<TopologyRuleAction> actions;

    private DynObject parameters;

    protected AbstractTopologyRule(

            TopologyPlan plan,

            TopologyRuleFactory factory,

            double tolerance,

            String dataSet1,

            String dataSet2

    ) {

        this.plan = plan;

        this.factory = factory;

        this.tolerance = tolerance;

        this.dataSet1 = dataSet1;

        this.dataSet2 = dataSet2;

        this.actions = new ArrayList<>();

    }

    protected AbstractTopologyRule(

            TopologyPlan plan,

            TopologyRuleFactory factory,

            double tolerance,

            String dataSet1

    ) {

        this(plan, factory, tolerance, dataSet1, null);

    }

    protected TopologyPlan getPlan() {

        return this.plan;

    }

    @Override

    public TopologyRuleFactory getFactory() {

        return this.factory;

    }

    @Override

    public String getName() {

        return this.getFactory().getName();

    }

    @Override

    public String getId() {

        return this.getFactory().getId();

    }

    public final void addAction(TopologyRuleAction action) {

        this.actions.add(action);

    }

    @Override

    public boolean equals(Object obj) {

        if( !(obj instanceof TopologyRule) ) {

            return false;

        }

        AbstractTopologyRule other = (AbstractTopologyRule)obj;

        if( !StringUtils.equals(this.getName(), other.getName()) ) {

            return false;

        }

        if( !StringUtils.equals(this.dataSet1, other.dataSet1) ) {

            return false;

        }

        if( !StringUtils.equals(this.dataSet2, other.dataSet2) ) {

            return false;

        }

        // Ojo con la comparacion de doubles

//        if( this.tolerance != other.tolerance ) {

//            return false;

//        }

        return true;

    }

    @Override

    public String toString() {

        return this.getName();

    }

    @Override

    public TopologyDataSet getDataSet1() {

        return this.getPlan().getDataSet(dataSet1);

    }

    @Override

    public TopologyDataSet getDataSet2() {

        return this.getPlan().getDataSet(dataSet2);

    }

    @Override

    public double getTolerance() {

        return this.tolerance;

    }

    @Override

    public List<TopologyRuleAction> getActions() {

        return Collections.unmodifiableList(actions);

    }

    @Override

    public TopologyRuleAction getAction(String id) {

        for (TopologyRuleAction action : actions) {

            if (StringUtils.equalsIgnoreCase(id, action.getId())) {

                return action;

            }

        }

        return null;

    }

    @Override

    public long getSteps() {

        return this.getDataSet1().getSize();

    }

    @Override

    public void execute(final SimpleTaskStatus taskStatus, final TopologyReport report) {

        try {

            this.getDataSet1().accept(new Visitor() {

                @Override

                public void visit(final Object o1) throws VisitCanceledException, BaseException {

                    if( taskStatus.isCancellationRequested() ) {

                        throw new VisitCanceledException();

                    }

                    taskStatus.incrementCurrentValue();

                    try {

                        check(taskStatus, report, (Feature) o1);

                    } catch (Exception ex) {

                        throw new RuntimeException(ex);

                    }

                }

            });

        } catch(VisitCanceledException ex) {

            // return;

        }

    }

    protected void check(SimpleTaskStatus taskStatus, TopologyReport report, Feature feature) throws Exception {

    }

    @Override

    public JSONObject toJSON() {

        JSONObject me = new JSONObject();

        me.put("tolerance", this.tolerance);

        me.put("dataSet1", this.dataSet1);

        me.put("dataSet2", this.dataSet2);

        DynObject params = this.getParameters();

        if(params!= null) {

            JSONObject jsonParams = new JSONObject();

            DynClass parametersDefinition = params.getDynClass();

            for (DynField dynField : parametersDefinition.getDynFields()) {

                jsonParams.put(dynField.getName(), params.getDynValue(dynField.getName()));

            }

            me.put("params", jsonParams);

        }

        return me;

    }

    @Override

    public void fromJSON(String json) {

        this.fromJSON(new JSONObject(json));

    }

    @Override

    public void fromJSON(JSONObject json) {

//        this.report = null;

        if( json.has("tolerance") ) {

            this.tolerance = json.getDouble("tolerance");

        }

        if( json.has("dataSet1") ) {

            this.dataSet1 = json.getString("dataSet1");

        }

        if( json.has("dataSet2") ) {

            this.dataSet2 = json.getString("dataSet2");

        }

        if( json.has("params") ) {

            JSONObject jsonParams = json.getJSONObject("params");

            DynObject params = this.getFactory().createRuleParameters();

            DynClass parametersDefinition = params.getDynClass();

            for (DynField dynField : parametersDefinition.getDynFields()) {

                String paramName = dynField.getName();

                if (jsonParams.has(paramName)){

                    params.setDynValue(paramName, jsonParams.getString(paramName));

                }

            }

            this.setParameters(params);

        }

    }

    @Override

    public void setParameters(DynObject parameters) {

        this.parameters=parameters;

    }

    @Override

    public DynObject getParameters() {

        return this.parameters;

    }

}

/**

 * 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.topology.lib.spi;

import java.net.URL;

import java.util.List;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynform.DynFormLocator;

import org.gvsig.tools.dynform.DynFormManager;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.topology.lib.api.TopologyDataSet;

import org.gvsig.topology.lib.api.TopologyRuleFactory;

import org.json.JSONObject;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;