Application: gvSIG desktop

<?xml version="1.0" encoding="UTF-8"?>

<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>

	<artifactId>org.gvsig.metadata.lib.basic.impl</artifactId>

	<packaging>jar</packaging>

	<name>org.gvsig.metadata.lib.basic.impl</name>

	<description>Metadata library basic implementation</description>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.metadata.basic.lib</artifactId>

		<version>2.0.89</version>

	</parent>

	<dependencies>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.metadata.lib.basic.api</artifactId>

		</dependency>

	    <dependency>

	        <groupId>org.gvsig</groupId>

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

	    </dependency>

	</dependencies>

</project>

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

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="UTF-8" ?>

<!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

	DefaultExampleManager class.

	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.metadata.basic.impl.DefaultExampleManager">

		<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>

#set( $symbol_pound = '#' )

#set( $symbol_dollar = '$' )

#set( $symbol_escape = '\' )

For each class you are going to test, create one Test class with the same

name as the class to test, ending with Test.

For example, the unit tests of the "ExampleLibrary" class are performed

by the "ExampleLibraryTest" class.

/**

 * 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.metadata.lib.basic.impl;

import org.gvsig.metadata.Metadata;

import org.gvsig.metadata.MetadataContainer;

import org.gvsig.metadata.MetadataManager;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynStruct;

public class BasicMetadataManager extends AbstractMetadataManager implements

		MetadataManager {

	protected Metadata createMetadata(DynStruct definition) {

		return new DefaultMetadata(definition);

	}

	protected MetadataContainer createMetadataContainer(DynClass dynClass) {

		return new BasicMetadataContainer(dynClass);

	}

}

/**

 * 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.metadata.lib.basic.impl;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.xmlpull.v1.XmlPullParserException;

import org.gvsig.metadata.Metadata;

import org.gvsig.metadata.MetadataContainer;

import org.gvsig.metadata.MetadataManager;

import org.gvsig.metadata.exceptions.AddMetadataDefinitionException;

import org.gvsig.metadata.exceptions.DuplicateMetadataDefinitionException;

import org.gvsig.metadata.exceptions.InvalidMetadataNamespaceException;

import org.gvsig.metadata.exceptions.MetadataException;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObjectManager;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.dynobject.impl.DefaultDynClassName;

import org.gvsig.tools.persistence.impl.exception.CantFindDefinitionInStreamException;

/**

 * Abstract metadata manager used in both metadata basic and full modules.

 */

public abstract class AbstractMetadataManager implements MetadataManager {

	private final Logger LOG = LoggerFactory

			.getLogger(AbstractMetadataManager.class);

	private Map metadataItems;

	protected DynObjectManager dynManager;

	protected File metadataHomeFile = null;

	private boolean doSavingValidation;

	private boolean doExportingValidation;

	public AbstractMetadataManager() {

		dynManager = ToolsLocator.getDynObjectManager();

	}

	protected void initDefinitions() {

		this.metadataItems = new HashMap();

		Iterator definitionsIter = ToolsLocator.getDynObjectManager().iterator(

				MetadataManager.METADATA_NAMESPACE);

		DynStruct definition;

		while (definitionsIter.hasNext()) {

			definition = (DynStruct) definitionsIter.next();

			if (!this.getMetadataItems().containsKey(definition)) {

				Metadata metadata = createMetadata(definition);

				this.getMetadataItems().put(definition, metadata);

			}

		}

	}

	public DynStruct addDefinition(String name, String description)

			throws MetadataException {

		DynClass definition = dynManager.createDynClass(METADATA_NAMESPACE,

				name, description);

		addDefinition(definition);

		return definition;

	}

	public DynStruct addDefinition(String metadataDefinitionName,

			InputStream stream, ClassLoader loader) throws MetadataException {

		Map x;

		try {

			x = dynManager.importDynClassDefinitions(stream, loader,

					METADATA_NAMESPACE);

		} catch (XmlPullParserException e) {

			throw new AddMetadataDefinitionException(e, metadataDefinitionName);

		} catch (IOException e) {

			throw new AddMetadataDefinitionException(e, metadataDefinitionName);

		}

		DynClass definition = (DynClass) x.get(metadataDefinitionName);

		if (definition == null) {

			throw new CantFindDefinitionInStreamException(

					metadataDefinitionName, getKeys(x));

		}

		addDefinition(definition);

		return definition;

	}

	private String getKeys(Map theMap) {

		return new ArrayList(theMap.keySet()).toString();

	}

	public DynStruct getDefinition(Metadata metadata) throws MetadataException {

		return dynManager.get(METADATA_NAMESPACE, metadata.getMetadataName());

	}

	public DynStruct getDefinition(String metadataName) {

		if (metadataName == null)

			return null;

		if (metadataName.contains(":")) {

			int index = metadataName.lastIndexOf(":");

			return dynManager.get(metadataName.substring(0, index),

					metadataName.substring(index + 1, metadataName.length()));

		}

		return dynManager.get(METADATA_NAMESPACE, metadataName);

	}

	public void addDefinition(DynClass definition) throws MetadataException {

		if (definition == null) {

			return;

		}

		if ((definition.getNamespace() == null)

				|| (definition.getNamespace().equals(""))) {

			definition.setNamespace(METADATA_NAMESPACE);

		}

		if (!METADATA_NAMESPACE.equalsIgnoreCase(definition.getNamespace())) {

			throw new InvalidMetadataNamespaceException(definition.getName(),

					definition.getNamespace());

		}

		if (dynManager.get(definition.getNamespace(), definition.getName()) != null) {

			throw new DuplicateMetadataDefinitionException(definition.getName());

		}

		dynManager.add(definition);

		LOG.trace("Registered metadata definition {}.",

				definition.getFullName());

	}

	public void removeDefinition(DynStruct dynStruct) {

		if (dynStruct == null)

			return;

		this.metadataItems.remove(dynStruct);

		dynManager.remove(dynStruct);

	}

	public MetadataContainer createMetadataContainer(String name) {

		DynClass dynClass = dynManager.get(METADATA_NAMESPACE, name);

		if (dynClass == null) {

			throw new IllegalArgumentException(

					"Can't locate class '"

							+ new DefaultDynClassName(METADATA_NAMESPACE, name)

									.getFullName() + "'.");

		}

		return createMetadataContainer(dynClass);

		// return new BasicMetadataContainer(dynClass);

	}

	protected abstract MetadataContainer createMetadataContainer(

			DynClass dynClass);

	public void storeMetadata(Metadata metadata) throws MetadataException {

		// In SimpleMetadataManager do nothing

	}

	public void loadMetadata(Metadata metadata) throws MetadataException {

		// In SimpleMetadataManager do nothing

	}

	private Map getMetadataItems() {

		if (this.metadataItems == null) {

			initDefinitions();

		}

		return this.metadataItems;

	}

	public Metadata getMetadata(DynStruct definition)

			throws InvalidMetadataNamespaceException {

		if (this.getMetadataItems().containsKey(definition)) {

			return (Metadata) this.getMetadataItems().get(definition);

		}

		if (definition == null) {

			return null;

		}

		if ((definition.getNamespace() == null)

				|| (!definition.getNamespace().equals(METADATA_NAMESPACE))) {

			throw new InvalidMetadataNamespaceException(definition);

		}

		Metadata metadata = createMetadata(definition);

		this.getMetadataItems().put(definition, metadata);

		LOG.trace("Registered metadata definition {}.",

				definition.getFullName());

		return metadata;

	}

	protected abstract Metadata createMetadata(DynStruct definition);

	public File getMetadataHomeRepository() {

		if (this.metadataHomeFile == null) {

			String path = System.getProperty("user.home");

			path += File.separator + ".org.gvsig.metadata";

			this.metadataHomeFile = new File(path);

		}

		if (!this.metadataHomeFile.exists()) {

			this.metadataHomeFile.mkdirs();

		}

		return this.metadataHomeFile;

	}

	public File getRepositoryFile(String relativePath) {

		if ((relativePath == null) || (relativePath.equals("")))

			return this.metadataHomeFile;

		return new File(getMetadataHomeRepository().toString() + File.separator

				+ relativePath);

	}

	public void storeDefinitions() {

		Iterator it = ToolsLocator.getDynObjectManager().iterator(

				METADATA_NAMESPACE);

	}

	public Iterator getDefinitions() {

		// initDefinitions();

		return getMetadataItems().values().iterator();

	}

	public void setMetadataHomeRepository(File metadataHomeFile) {

		if (metadataHomeFile == null) {

			return;

		}

		this.metadataHomeFile = metadataHomeFile;

		if (!this.metadataHomeFile.exists())

			this.metadataHomeFile.mkdirs();

	}

	public Metadata getMetadata(String metadataID)

			throws InvalidMetadataNamespaceException {

		return this.getMetadata(getDefinition(metadataID));

	}

	public void setValidationBeforeSaving(boolean doValidation) {

		this.doSavingValidation = doValidation;

	}

	public boolean getValidationBeforeSaving() {

		return this.doSavingValidation;

	}

	public void setValidationBeforeExporting(boolean doValidation) {

		this.doExportingValidation = doValidation;

	}

	public boolean getValidationBeforeExporting() {

		return this.doExportingValidation;

	}

}

/**

 * 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.metadata.lib.basic.impl;

import org.gvsig.metadata.exceptions.AddMetadataDefinitionException;

public class CantFindDefinitionInStreamException extends AddMetadataDefinitionException {

	/**

	 * 

	 */

	private static final long serialVersionUID = 450922621905049558L;

	public CantFindDefinitionInStreamException(String name) {

		super(

			"Can't find metadata definition %(name) in stream.", 

			"_cant_find_metadata_definition_XnameX_in_stream", 

			serialVersionUID

		);

		setValue("name",name);

	}

	public CantFindDefinitionInStreamException(String name, String found) {

		super(

				"Can't find metadata definition %(name) in stream, found %(found).", 

				"_cant_find_metadata_definition_XnameX_in_stream_found_XfoundX", 

				serialVersionUID

			);

		setValue("name",name);

		setValue("found",found);

	}

}

/**

 * 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.metadata.lib.basic.impl;

import java.util.HashSet;

import java.util.Set;

import org.gvsig.metadata.Metadata;

import org.gvsig.metadata.exceptions.MetadataException;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.dynobject.impl.DefaultDynObject;

/**

 * Abstract metadata used in both metadata basic and full modules.

 */

public abstract class AbstractMetadata extends DefaultDynObject implements

		Metadata, Comparable {

	public AbstractMetadata(DynStruct dynClass) {

		super(dynClass);

	}

	public Set getMetadataChildren() throws MetadataException {

		Set children = new HashSet();

		DynStruct[] items = this.getDynClass().getSuperDynStructs();

		if (items == null)

			return children;

		Object item;

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

			item = items[i];

			if (item instanceof Metadata) {

				children.add(item);

			}

		}

		return children;

	}

	public Object getMetadataID() throws MetadataException {

		return this.getDynClass().getFullName();

	}

	public String getMetadataName() throws MetadataException {

		return this.getDynClass().getName();

	}

	public int compareTo(Object object) {

		if (object == null) {

			return 0;

		}

		if (object instanceof Metadata) {

			return this

					.getDynClass()

					.getFullName()

					.toLowerCase()

					.compareTo(

							((Metadata) object).getDynClass().getFullName()

									.toLowerCase());

		}

		if (object instanceof DynStruct) {

			return this

					.getDynClass()

					.getFullName()

					.toLowerCase()

					.compareTo(((DynStruct) object).getFullName().toLowerCase());

		}

		return 0;

	}

	public String toString() {

		String name = this.getDynClass().getName();

		return name.substring(0, 1).toUpperCase() + name.substring(1);

	}

	public String toDynObjectString() {

		return super.toString();

	}

}

/**

 * 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.metadata.lib.basic.impl;

import org.gvsig.metadata.MetadataContainer;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.dynobject.impl.DefaultDynObject;

public class BasicMetadataContainer extends DefaultDynObject implements MetadataContainer {

	public BasicMetadataContainer(DynStruct dynClass) {

		super(dynClass);

	}

}

/**

 * 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.metadata.lib.basic.impl;

import org.gvsig.metadata.Metadata;

import org.gvsig.tools.dynobject.DynStruct;

/**

 * Default metadata implementation of the basic implementation module.

 */

public class DefaultMetadata extends AbstractMetadata implements Metadata {

	public DefaultMetadata(DynStruct dynClass) {

		super(dynClass);

	}

}

/**

 * 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.metadata.lib.basic.impl;

import java.util.Locale;

import org.gvsig.metadata.MetadataLibrary;

import org.gvsig.metadata.MetadataLocator;

import org.gvsig.metadata.MetadataManager;

import org.gvsig.tools.ToolsLibrary;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

public class BasicMetadataLibrary extends AbstractLibrary {

	public void doRegistration() {

		super.doRegistration();

		require(ToolsLibrary.class);

		registerAsImplementationOf(MetadataLibrary.class);

	}

	protected void doInitialize() throws LibraryException {

        MetadataLocator.registerMetadataManager(BasicMetadataManager.class);

        I18nManager i18nManager = ToolsLocator.getI18nManager();

        i18nManager.addResourceFamily("org.gvsig.metadata.basic.impl.i18n.text",

				BasicMetadataLibrary.class.getClassLoader(),

				BasicMetadataLibrary.class.getClass().getName());

	}

	protected void doPostInitialize() throws LibraryException {

		MetadataManager metadataManager = MetadataLocator.getMetadataManager();

		if (!(metadataManager instanceof MetadataManager)) {

			throw new LibraryException(BasicMetadataManager.class, null);

		}

	}

}

<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<title>org.gvsig.metadata.basic package documentation</title>

</head>

<body>

	<p>TODO: Example library overview.</p>

	<p>See the <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#overviewcomment">Javadoc Tool documentation about the overview file</a></p>

</body>

</html>

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

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

through the ClassLoader.

By default, into this folder you can find some examples of resource bundle 

property files that may be used by your library classes.

org.gvsig.metadata.lib.basic.impl.BasicMetadataLibrary

# Resource bundle texts for the Spanish language locale (es)

Example.returns_value=devuelve el valor

# Resource bundle texts for the English language locale (en)

Example.returns_value=returns value

<?xml version="1.0" encoding="UTF-8"?>

<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>

  <artifactId>org.gvsig.metadata.basic.lib</artifactId>

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

  <packaging>pom</packaging>    

  <description>This project contains the basic metadata features.</description>

  <parent>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.metadata.basic</artifactId>

      <version>2.0.89</version>

  </parent>  

  <modules>

    <module>org.gvsig.metadata.lib.basic.api</module>

    <module>org.gvsig.metadata.lib.basic.impl</module>

  </modules>

</project>

/**

 * 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.metadata;

import java.io.File;

import java.io.InputStream;

import java.util.Iterator;

import org.gvsig.metadata.exceptions.InvalidMetadataNamespaceException;

import org.gvsig.metadata.exceptions.MetadataException;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynStruct;

/**

 * Manages the load and storage of Metadata objects.

 * 

 * @author gvSIG Team

 * @author <a href="mailto:cordin@disid.com">C?sar Ordi?ana</a>

 * @author <a href="mailto:reinhold@uji.es">cmartin</a>

 * 

 * @version $Id$

 * 

 */

public interface MetadataManager {

	public final static String METADATA_NAMESPACE = "metadata";

	/**

	 * Adds a new definition in the metadata manager.

	 * 

	 * The new definition is defined in the namespace by default for DynClasses

	 * used for metadata.

	 * 

	 * @param name

	 *            the definition Name

	 * @param description

	 *            the definition Description

	 * @return the created DynStruct definition

	 * 

	 * @throws MetadataException

	 */

	public DynStruct addDefinition(String name, String description)

			throws MetadataException;

	/**

	 * Adds a new definition in the metadata manager.

	 * 

	 * The new definition is defined in the namespace by default for DynClasses

	 * used for metadata.

	 * 

	 * @param dynClass

	 *            the new definition

	 * 

	 * @return the DynStruct definition

	 * 

	 * @throws MetadataException

	 */

	public void addDefinition(DynClass definition) throws MetadataException;

	/**

	 * Adds a new definition in the metadata manager.

	 * 

	 * The new definition is defined in the namespace by default for DynClasses

	 * used for metadata.

	 * 

	 * @param name

	 *            the definition Name

	 * @param stream

	 *            the input stream to be parsed.

	 * @param loader

	 *            the Class loader that can parse this input stream

	 * @return the created DynStruct definition

	 * 

	 * @throws MetadataException

	 */

	public DynStruct addDefinition(String name, InputStream stream,

			ClassLoader loader) throws MetadataException;

	/**

	 * <p>

	 * If a Metadata definition ( {@link DynStruct} ) with the given definition

	 * name has been previously registered in this manager, then this method

	 * returns that definition. Otherwise, it returns null.

	 * </p>

	 * 

	 * @param definitionName

	 *            the name whose corresponding attribute definition is to be

	 *            retrieved.

	 * 

	 * @return The attribute definition corresponding to the provided metadata

	 *         class, or null otherwise.

	 */

	public DynStruct getDefinition(String definitionName);

	/**

	 * <p>

	 * Retrieves all the current definitions in the form of an Iterator

	 * interface.

	 * </p>

	 * 

	 * @return The Metadata iterator containing the current metadata definitions

	 */

	public Iterator getDefinitions();

	/**

	 * <p>

	 * If a Metadata definition ( {@link DynStruct} ) with a given metadata that

	 * has been previously registered in this manager, then this method returns

	 * that definition. Otherwise, it returns null.

	 * </p>

	 * 

	 * @param metadata

	 *            the given metadata.

	 * 

	 * @return The attribute definition corresponding to the provided metadata

	 *         class, or null otherwise.

	 */

	public DynStruct getDefinition(Metadata metadata) throws MetadataException;

	/**

	 * 

	 * If the current dynStruct has been previously registered, it is removed

	 * from both the dynObjectManager and the metadataManager lists. Otherwise,

	 * does nothing.

	 * 

	 * @param dynStruct

	 *            the dynStruct to be removed.

	 */

	public void removeDefinition(DynStruct dynStruct);

	/**

	 * Creates a default {@link Metadata} instance based on a given

	 * {@link DynStruct}, if it has not been previously registered, and adds

	 * this Metadata to the system.

	 * 

	 * @param dynStruct

	 *            the given dynStruct object.

	 * @return the resultant Metadata object.

	 * @throws InvalidMetadataNamespaceException

	 */

	public Metadata getMetadata(DynStruct dynStruct)

			throws InvalidMetadataNamespaceException;

	/**

	 * This function populates the given Metadata object with the current values

	 * that the system contains. If there is any invalid access to an undeclared

	 * field, for example, a MetadataException will be thrown.

	 * 

	 * @param metadata

	 *            the metadata that needs to be populated.

	 * 

	 * @throws MetadataException

	 *             Exception caused by any access violation.

	 */

	public void loadMetadata(Metadata metadata) throws MetadataException;

	/**

	 * This function stores the given Metadata object to an output resource, be

	 * it a database or a file containing its information.

	 * 

	 * @param metadata

	 *            the metadata that needs to be stored.

	 * 

	 * @throws MetadataException

	 *             Exception caused by any access violation.

	 */

	public void storeMetadata(Metadata metadata) throws MetadataException;

	/**

	 * This is a utility interface to implement classes that implement the

	 * interface Metadata.

	 * 

	 * Use the createMetadataContainer in the MetadataManager to create a

	 * container for delegate the implementation of Metadata methods in it.

	 * 

	 * @param name

	 *            the DynStruct name.

	 * 

	 * @return the metadata container.

	 */

	public MetadataContainer createMetadataContainer(String name);

	/**

	 * Returns the main Metadata extension root repository.

	 * 

	 * @return the File object containing the home repository folder

	 * 

	 */

	public File getMetadataHomeRepository();

	/**

	 * Sets the main Metadata root repository for this manager.

	 * 

	 * @param metadataHomeRepository

	 *            the main Repository folder.

	 */

	public void setMetadataHomeRepository(File metadataHomeRepository);

	/**

	 * Retrieves a metadata object based on its metadata ID. This metadata

	 * object is basically a dynObject if metadata namespace set to "metadata".

	 * 

	 * @param metadataID

	 *            the metadata ID of the metadata object.

	 * @return

	 * @throws InvalidMetadataNamespaceException

	 *             if the metadataID was not previously registered as Metadata.

	 */

	public Metadata getMetadata(String metadataID)

			throws InvalidMetadataNamespaceException;

	/**

	 * Added options properties setter for validating before the saving

	 * function. If it is set to false, the validation will not be performed.

	 * @param doValidation

	 *		if the validation must be performed or not before saving metadata objects.

	 */

	public void setValidationBeforeSaving(boolean doValidation);

	/**

	 * Added options properties getter for validating before the saving

	 * function. If it is set to false, the validation will not be performed.

	 * @return

	 *            if the validation must be performed or not before saving metadata objects.

	 */

	public boolean getValidationBeforeSaving();

	/**

	 * Added options properties setter for validating before the exporting

	 * function. If it is set to false, the validation will not be performed.

	 * @param doValidation

	 *		if the validation must be performed or not before saving metadata objects.

	 */

	public void setValidationBeforeExporting(boolean doValidation);

	/**

	 * Added options properties getter for validating before the exporting

	 * function. If it is set to false, the validation will not be performed.

	 * @return

	 *            if the validation must be performed or not before saving metadata objects.

	 */

	public boolean getValidationBeforeExporting();

}

/**

 * 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.metadata;

import java.util.Set;

import org.gvsig.metadata.exceptions.MetadataException;

import org.gvsig.tools.dynobject.DynObject;

/**

 * Metadata is information or data about data {@link http

 * ://en.wikipedia.org/wiki/Metadata}.

 * <p>

 * This interface extends DynObject to add anything needed over the DynObject

 * model to be able to be used as a Metadata model.

 * </p>

 * 

 * @author gvSIG Team

 * @author <a href="mailto:cordin@disid.com">C?sar Ordi?ana</a>

 * @author <a href="mailto:reinhold@uji.es">cmartin</a>

 * @version $Id$

 * 

 */

public interface Metadata extends DynObject {

	/**

	 * Returns the unique identifier of the Metadata.

	 * 

	 * @return the Metadata identifier

	 */

	public Object getMetadataID() throws MetadataException;

	/**

	 * Returns the name of the Metadata, which allows to identify the type in

	 * the Metadata registry.

	 * 

	 * @return the Metadata name

	 */

	public String getMetadataName() throws MetadataException;

	/**

	 * Returns an unsorted set of child Metadata objects.

	 * 

	 * @return an unsorted set of child Metadata objects

	 */

	public Set getMetadataChildren() throws MetadataException;

}

/**

 * 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.metadata.exceptions;

public class AddMetadataDefinitionException extends MetadataException {

	/**

	 * 

	 */

	private static final long serialVersionUID = 564722264607592985L;

	public AddMetadataDefinitionException(Throwable cause, String name) {

		super("Can't add definition %(name) to metadata manager.", cause,

				"_Cant_add_definition_XnameX_to_metadata_manager",

				serialVersionUID);

	}

	protected AddMetadataDefinitionException(String message, String key,

			long code) {

		super(message, key, code);

	}

}

/**

 * 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.metadata.exceptions;

public class DuplicateMetadataDefinitionException extends

		AddMetadataDefinitionException {

	/**

	 * 

	 */

	private static final long serialVersionUID = 1774035106179247051L;

	private final static String MESSAGE_FORMAT = "Duplicated name (%(name)s) in definition of metadata.";

	private final static String MESSAGE_KEY = "_DuplicateMetadataDefinitionException";

	public DuplicateMetadataDefinitionException(String name) {

		super(MESSAGE_FORMAT, MESSAGE_KEY, serialVersionUID);

		this.setValue("name", name);

	}

}

/**

 * 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.metadata.exceptions;

import org.gvsig.tools.dynobject.DynStruct;

public class InvalidMetadataNamespaceException extends MetadataException {

	/**

	 * 

	 */

	private static final long serialVersionUID = 7848869189284006672L;

	private final static String MESSAGE_FORMAT = "Invalid namespace '%(namespace)s' for class '%(names)s' in metadata context.";

	private final static String MESSAGE_KEY = "_InvalidMetadataNamespaceException";

	public InvalidMetadataNamespaceException(String definitionName,

			String namespace) {

		super(MESSAGE_FORMAT, MESSAGE_KEY, serialVersionUID);

		this.setValue("name", definitionName);

		this.setValue("namespace", namespace);

	}

	public InvalidMetadataNamespaceException(DynStruct dynStruct) {

		super(MESSAGE_FORMAT, MESSAGE_KEY, serialVersionUID);

		this.setValue("name", dynStruct.getName());

		this.setValue("namespace", dynStruct.getNamespace());

	}

}

/**

 * 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.metadata.exceptions;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.exception.BaseRuntimeException;