Application: gvSIG desktop

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

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

    <groupId>org.gvsig</groupId>

    <artifactId>org.gvsig.timesupport</artifactId>

    <packaging>pom</packaging>

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

    <description>TimeSupport example project</description>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.desktop.library</artifactId>

        <version>2.0.210</version>

    </parent>

    <build>

        <plugins>

            <plugin>

                <groupId>org.codehaus.mojo</groupId>

                <artifactId>animal-sniffer-maven-plugin</artifactId>

                <configuration>

                    <skip>true</skip>

                </configuration>

            </plugin>

        </plugins>

    </build>

    <dependencyManagement>

        <dependencies>

            <dependency>

                <groupId>org.swinglabs</groupId>

                <artifactId>swingx</artifactId>  	

                <version>1.6</version>

            </dependency>

            <dependency>

                <groupId>com.toedter</groupId>

                <artifactId>jcalendar</artifactId>

                <version>1.3.2</version>  				

            </dependency>	

        </dependencies>

    </dependencyManagement>

    <modules>

        <module>org.gvsig.timesupport.lib</module>

        <module>org.gvsig.timesupport.swing</module>	

    </modules>

</project>

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

<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.timesupport.lib</artifactId>

    <packaging>pom</packaging>

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

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.timesupport</artifactId>

        <version>2.0.210</version>

    </parent>

    <modules>

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

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

    </modules>

</project>

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

/**

 * <p>

 * This object is in the top level of the time hierarchy. All the temporal 

 * objects have to inherit of this interface.

 * </p>

 * 

 * @see https://gvsig.org/web/projects/gvsig-desktop/docs/devel/org-gvsig-sensors/1-0.0/analysis-and-design/detailed-view/time-support/libraries/org-gvsig-timesupport-lib

 * 

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface Time {

    /**

     * Does this time intersects with the time passed.

     * @param time

     *          an instant to check against, null means now 

     * @return

     *          <code>true</code> if the time intersects with the time passed in

     */

    public boolean intersects(Time time);

    /**

     * Checks if the time is a relative temporal type, that is an object that has

     * a Chronology that establish how a time object can be converted into other

     * object with date time fields.

     * @return

     *          <code>true</code) if the time object is relative

     */

    public boolean isRelative();

    /**

     * Checks if the time is an absolute temporal type, that is an object that doesn't

     * has a time zone.

     * @return

     *          <code>true</code> if the time object is absolute

     */

    public boolean isAbsolute();

    /**

     * Checks if the time is an interval, that is an object that represents 

     * a period of time between two instants.

     * @return

     *          <code>true</code> if the time object is an interval

     */

    public boolean isInterval();

    /**

     * Checks if the time is an instant, that is an object that represents 

     * a position in a time scale. In practice, an instant is an interval 

     * whose duration is less than the resolution of the time scale.

     * @return

     *          <code>true</code> if the time object is an instant.

     */

    public boolean isInstant();

    /**

     * Gets the chronology of the instant. The Chronology provides conversion 

     * from the millisecond value to meaningful fields in a particular calendar system. 

     * @return

     *      the Chronology, never null

     */

    public Chronology getChronology();

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

/**

 * <p>

 * This interface defines a set of constants for basic time data types.

 * </p>

 * 

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface DataTypes extends org.gvsig.tools.dataTypes.DataTypes {

    public static final int INSTANT = OBJECT + 4;

    public static final int INTERVAL = OBJECT + 5;

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

/**

 * Exception thrown when there is an error getting a TimeSupport message.

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class AbsoluteInstantTypeNotRegisteredException extends TimeSupportException {

    private static final long serialVersionUID = -4051458353306878010L;

    private static final String MESSAGE =

        "An error has been produced " + "getting the AbsoluteInstantTypeNotRegisteredException";

    private static final String KEY = "_AbsoluteInstantTypeNotRegisteredException";

    /**

     * Creates a new {@link AbsoluteInstantTypeNotRegisteredException}.

     * 

     * @param cause

     *            the original cause

     */

    public AbsoluteInstantTypeNotRegisteredException(int dateTimeFieldTypeNotRegisteredException) {

        super(MESSAGE, null, KEY, serialVersionUID);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport.animation;

import org.gvsig.timesupport.RelativeInstant;

/**

 * Data model for animation. This is useful to configure the animation

 * parameters. When the animation runs read the values of this object.

 * 

 * @author <a href="mailto:nachobrodin@gmail.com">Nacho Brodin</a>

 * 

 */

public interface TimeAnimationDataModel {

	public static final int          PLAY    = 0;

	public static final int          STOP    = 1;

	public static final int          PAUSE   = 2;

	public static final int          CLOSE   = 3;

	public static final int          ACCEPT  = 0;

	public static final int          CANCEL  = 1;

	//*************************

	/**

	 * Assigns the window time. The scale is the selected with the

	 * method setWindowScale.

	 * @param windowTime

	 *        Window of time of each step

	 */

	public void setWindowTime(int windowTime);

	/**

	 * Gets the window time. The scale is the selected with the

	 * method setWindowScale.

	 */

	public int getWindowTime();

	/**

	 * Gets the initial speed in milliseconds

	 * @param speed

	 */

	public int getTimeStep();

	/**

	 * Sets the animation speed 

	 * @param speed

	 *        Speed in milliseconds

	 */

	public void setTimeStep(int timeStep);

	/**

	 * Returns a constant defined in TimeAnimation. This constant represents the

	 * scale of time of the window (year, month, day, ...)

	 * @return

	 */

	public int getWindowTimeScale();

	/**

	 * Assigns a constant defined in TimeAnimation. This constant represents the

	 * scale of time of the window (year, month, day, ...)

	 * @return

	 */

	public void setWindowTimeScale(int windowTimeScale);

	/**

	 * Returns a constant defined in TimeAnimation. This constant represents the

	 * scale of time of the time step (year, month, day, ...)

	 * @return

	 */

	public int getTimeStepScale();

	/**

	 * Assigns a constant defined in TimeAnimation. This constant represents the

	 * scale of time of the time step (year, month, day, ...)

	 * @return

	 */

	public void setTimeStepScale(int timeStepScale);

	//*************************

	/**

	 * Gets the time step initial value in the text field

	 * @param timeStep

	 */

	public int getSpeed();

	/**

	 * Sets the speed of progress

	 * @param speed

	 */

	public void setSpeed(int speed);

	/**

	 * Gets the number of iterations

	 * @return

	 */

	public int getIterations();

	/**

	 * Sets the number of iterations

	 * @param iterations

	 */

	public void setIterations(int iterations);

	/**

	 * Gets the number of loops

	 * @return

	 */

	public int getLoop();

	/**

	 * Sets the number of loops

	 * @return

	 */

	public void setLoop(int loop);

	//***************************

	/**

	 * Sets the time window to visualize in each time instant. The time window is the

	 * amount of data to show in each step. At the beginning this window goes from the

	 * initial data time. When the animation has been started this window is moving along

	 * the time line. 

	 * @param start

	 *        Instant in which the animation starts

	 * @param end

	 *        Instant in which the animation ends

	 */

	public void setTimeWindow(RelativeInstant start, RelativeInstant end);

	/**

	 * Gets the end of the time window to visualize in each time instant. The time window is the

	 * amount of data to show in each step. At the beginning this window goes from the

	 * initial data time. When the animation has been started this window is moving along

	 * the time line. 

	 * @return {@link RelativeInstant}

	 */

	public RelativeInstant getEndTimeWindow();

	/**

	 * Gets the begin of the time window to visualize in each time instant. The time window is the

	 * amount of data to show in each step. At the beginning this window goes from the

	 * initial data time. When the animation has been started this window is moving along

	 * the time line. 

	 * @return {@link RelativeInstant}

	 */

	public RelativeInstant getInitTimeWindow();

	//***************************

	/**

	 * Sets the time interval. The time interval contains two date. The start date is the moment

	 * in which the animation starts and in the end date the animation ends. 

	 * @param timeWindowValue

	 */

	public void setTimeInterval(RelativeInstant start, RelativeInstant end);

	/**

	 * Gets the initial date of the time window to visualize in each time instant. 

	 * The time window is the amount of data to show in each step.

	 * @return {@link RelativeInstant}

	 */

	public RelativeInstant getInitTime();

	/**

	 * Gets the end date of the time window to visualize in each time instant. 

	 * The time window is the amount of data to show in each step.

	 * @return {@link RelativeInstant}

	 */

	public RelativeInstant getEndTime();

	//***************************

	/**

	 * Gets an array of seven values. Each element of this 

	 * array represents the number of years, months, days, hours, 

	 * minutes, seconds and milliseconds of a window time.

	 */

	public int[] getWindowTimeByPartOfData();

	/**

	 * Gets an array of seven values. Each element of this 

	 * array represents the number of years, months, days, hours, 

	 * minutes, seconds and milliseconds of a step.

	 */

	public int[] getStepByPartOfData();

	/**

	 * Gets the slider position. This position is specified in real time. 

	 * @return {@link RelativeInstant} 

	 */

	public RelativeInstant getSliderPosition();

	/**

	 * Assigns the slider position. This position is specified in real time. 

	 * @param position

	 */

	public void setSliderPosition(RelativeInstant position);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport.animation;

import org.gvsig.timesupport.RelativeInstant;

/**

 * This interface should be implemented by clients of this module. The

 * library calls update function each time that an increment happen. 

 * 

 * @author <a href="mailto:nachobrodin@gmail.com">Nacho Brodin</a>

 * 

 */

public interface AnimateClient {

	/**

	 * Updates the animation client

	 * @param startDateTime

	 * 			Date when the step starts

	 * @param endDateTime

	 *          Date when the step ends

	 */

	public void update(RelativeInstant startDateTime, RelativeInstant endDateTime);

	/**

	 * This event is thrown when an iteration finishes. An iteration is a complete

	 * cycle from the start date to the finish date.

	 * @param endDateTime

	 * 			Date when the iteration ends

	 */

	public void endIteration(RelativeInstant endDateTime);

	/**

	 * This event is thrown when the animation finishes

	 */

	public void end();

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport.animation;

/**

 * Time animation main interface. That is the main interface to control an

 * animation by time.

 * 

 * @author <a href="mailto:nachobrodin@gmail.com">Nacho Brodin</a>

 * 

 */

public interface TimeAnimation {

	public static final int          YEAR         = 0;

	public static final int          MONTH        = 1;

	public static final int          WEEK         = 2;

	public static final int          DAY          = 3;

	public static final int          HOUR         = 4;

	public static final int          MINUTE       = 5;

	public static final int          SECOND       = 6;

	public static final int          MILLISECOND  = 7;

	public static final int          NO_LOOP      = 0;

	public static final int          LOOP         = 1;

	public static final int          LOOP_N       = 2;

	/**

	 * Gets the data model for time animation. Data model contains 

	 * the time window, the step, the speed of progress and other

	 * information about an animation

	 * @return {@link TimeAnimationDataModel}

	 */

	public TimeAnimationDataModel getDataModel();

	/**

	 * Sets the client which receives events from the animation

	 * @param client

	 *        Interface with the functions to call when the animation increase a step, ends

	 *        or an iteration ends

	 */

	public void setAnimateClient(AnimateClient client);

	/**

	 * Stops the animation

	 */

	public void stopAnimation();

	/**

	 * Pauses the animation

	 */

	public void pauseAnimation();

	/**

	 * Starts the animation

	 */

	public void startAnimation();

	/**

	 * Tests if this thread is alive. A thread is alive if it has been started and has not yet died. 

	 */

	public boolean isAlive();

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

/**

 * Exception thrown when there is an error getting a TimeSupport message.

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class AbsoluteIntervalTypeNotRegisteredException extends TimeSupportException {

    private static final long serialVersionUID = -4051458353306878010L;

    private static final String MESSAGE =

        "An error has been produced " + "getting the AbsoluteIntervalTypeNotRegisteredException";

    private static final String KEY = "_absoluteIntervalTypeNotRegisteredException";

    /**

     * Creates a new {@link AbsoluteIntervalTypeNotRegisteredException}.

     * 

     * @param cause

     *            the original cause

     */

    public AbsoluteIntervalTypeNotRegisteredException(int durationFieldTypeNotRegisteredException) {

        super(MESSAGE, null, KEY, serialVersionUID);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

/**

 * <p>

 * The {@link RelativeInstant} ins inmutable, but sometimes is necessary to

 * edit it. This class is an editable copy of a realtive instant that

 * cab be edited.

 * </p>

 * <p>

 * A huge part of the documentation of this class has been retrieved

 * from the joda-time library.

 * </p>

 * 

 * @see http://joda-time.sourceforge.net

 * @see https://gvsig.org/web/projects/gvsig-desktop/docs/devel/org-gvsig-sensors/1-0.0/analysis-and-design/detailed-view/time-support/libraries/org-gvsig-timesupport-lib

 * 

 * @author gvSIG Team

 * @version $Id$

 *

 */

public interface EditableRelativeInstant extends RelativeInstant{

    /**

     * Set the time from fields. The date part of this object will be unaffected.

     *

     * @param hour

     *          the hour

     * @param minuteOfHour

     *          the minute of the hour

     * @param secondOfMinute

     *          the second of the minute

     * @param millisOfSecond

     *          the millisecond of the second

     * @throws IllegalArgumentException if the value is invalid

     * 

     */

    public void setTime(final int hour, final int minuteOfHour, final int secondOfMinute, final int millisOfSecond);

    /**

     * Set the date from fields. The time part of this object will be unaffected.

     *

     * @param year

     *          the year

     * @param monthOfYear

     *          the month of the year

     * @param dayOfMonth

     *          the day of the month

     * @throws IllegalArgumentException if the value is invalid

     */

    public void setDate(final int year, final int monthOfYear, final int dayOfMonth);

    /**

     * Add a number of years to the date.

     *

     * @param years  the years to add

     * @throws IllegalArgumentException if the value is invalid

     */

    public void addYears(final int years);

    /**

     * Add a number of days to the date.

     *

     * @param days

     *          the days to add

     * @throws IllegalArgumentException if the value is invalid

     */

    public void addDays(final int days);

    /**

     * Add a number of hours to the date.

     *

     * @param hours  

     *          the hours to add

     * @throws IllegalArgumentException if the value is invalid

     */

    public void addHours(final int hours);

    /**

     * Add a number of minutes to the date.

     *

     * @param minutes

     *          the minutes to add

     * @throws IllegalArgumentException if the value is invalid

     */

    public void addMinutes(final int minutes);

    /**

     * Add a number of seconds to the date.

     *

     * @param seconds

     *            the seconds to add

     * @throws IllegalArgumentException if the value is invalid

     */

    public void addSeconds(final int seconds);

    /**

     * Add a number of millis to the date.

     *

     * @param millis

     *          the millis to add

     * @throws IllegalArgumentException if the value is invalid

     */

    public void addMillis(final int millis);

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

import org.gvsig.tools.exception.BaseException;

/**

 * Generic exception thrown in the TimeSupport API when the exception or error

 * may be dealt by the program or the user of the program which is a client of

 * the TimeSupport API.

 * 

 * @see {@link TimeFactoryService}

 * @see {@link TimeSupportManager}

 * @author gvSIG team.

 * @version $Id$

 */

public class TimeSupportException extends BaseException {

    private static final long serialVersionUID = 6756475060924237176L;

    private static final String MESSAGE =

        "An error has been produced in the TimeSupport library";

    private static final String KEY = "_TimeSupportException";

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <strong>Don't use this constructor in child classes.</strong>

     */

    public TimeSupportException() {

        super(MESSAGE, KEY, serialVersionUID);

    }

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <p>

     * <strong>Don't use this constructor in child classes.</strong>

     * </p>

     * 

     * @param cause

     *            the original cause of the exception

     */

    public TimeSupportException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected TimeSupportException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected TimeSupportException(String message, Throwable cause,

        String key, long code) {

        super(message, cause, key, code);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

import java.util.Date;

import org.gvsig.tools.lang.Cloneable;

/**

 * <p>

 * A relative instant is defined like an instant in the datetime continuum 

 * specified as a number of milliseconds from 1970-01-01T00:00Z. This definition 

 * of milliseconds is consistent with that of the JDK in Date or Calendar.

 * </p>

 * <p>It contains also a Chronology which determines how the millisecond 

 * instant value is converted into the date time fields. The default Chronology 

 * can be set using the {@link TimeSupportManager} class. (e.g: 1st January 2010)

 * </p>

 * <p>

 * A huge part of the documentation of this class has been retrieved

 * from the joda-time library.

 * </p>

 * 

 * @see http://joda-time.sourceforge.net

 * @see https://gvsig.org/web/projects/gvsig-desktop/docs/devel/org-gvsig-sensors/1-0.0/analysis-and-design/detailed-view/time-support/libraries/org-gvsig-timesupport-lib

 * 

 * @author gvSIG team

 * @version $Id$

 */

public interface RelativeInstant extends Instant, Cloneable{

    /**

     * Get the date time as a <code>java.util.Date</code>.

     * <p>

     * The <code>Date</code> object created has exactly the same millisecond

     * instant as this object.

     * </p>

     *

     * @return 

     *          a Date initialised with this relative instant

     */

    public Date toDate();

    /**

     * Compares this object with the specified object for ascending

     * millisecond instant order. This ordering is inconsistent with

     * equals, as it ignores the Chronology.

     *

     * @param instant

     *          a readable instant to check against

     * @return 

     *          negative value if this is less, 0 if equal, or positive 

     *          value if greater

     */

    public int compareTo(Instant instant);

    /**

     * Gets the milliseconds of the datetime instant from the Java epoch

     * of 1970-01-01T00:00:00Z.

     * 

     * @return 

     *          the number of milliseconds since 1970-01-01T00:00:00Z

     */

    public long toMillis();    

    /**

     * Get the year field value.

     * 

     * @return 

     *          the year

     */

    public int getYear();

    /**

     * Get the month of year field value.

     * 

     * @return 

     *          the month of year

     */

    public int getMonthOfYear();

    /**

     * Get the day of month field value.

     * 

     * @return 

     *          the day of month

     */

    public int getDayOfMonth();

    /**

     * Get the hour of day field value.

     * 

     * @return 

     *          the hour of month

     */

    public int getHourOfDay();

    /**

     * Get the minute of day field value.

     * 

     * @return 

     *          the minute of day

     */

    public int getMinuteOfDay();

    /**

     * Get the minute of hour field value.

     * 

     * @return 

     *          the minute of hour

     */

    public int getMinuteOfHour();   

    /**

     * Get the second of day field value.

     * 

     * @return 

     *          the second of day

     */

    public int getSecondOfDay();

    /**

     * Get the second of minute field value.

     * 

     * @return 

     *          the second of minute

     */

    public int getSecondOfMinute();

    /**

     * Get the millis of second field value.

     * 

     * @return 

     *          the millis of second

     */

    public int getMillisOfSecond();

    /**

     * Get an editable copy used to edit other instance of

     * a relative instant. The new copy is initialized with

     * the values of this intant.

     *    

     * @return

     *          a copy to edit the instant 

     */

    public EditableRelativeInstant getEditableCopy();

    /**

     * Output the instant using the specified format pattern.

     *

     * @param 

     *          pattern  the pattern specification, null means 

     *          use <code>toString</code>

     */

    public String toString(String pattern);   

}

<?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.timesupport package documentation</title>

</head>

<body>

	<p>TimeSupport library API.</p>

	<p>

	It allows to get new TimeSupport and get their text.

	</p>

</body>

</html>

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

import org.gvsig.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

/**

 * This locator is the entry point for the TimeSupport library, providing

 * access to all TimeSupport services through the {@link TimeSupportManager}

 * .

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class TimeSupportLocator extends BaseLocator {

    /**

     * TimeSupport manager name.

     */

    public static final String MANAGER_NAME = "TimeSupport.manager";

    /**

     * TimeSupport manager description.

     */

    public static final String MANAGER_DESCRIPTION = "TimeSupport Manager";

    private static final String LOCATOR_NAME = "TimeSupport.locator";

    /**

     * Unique instance.

     */

    private static final TimeSupportLocator INSTANCE =

        new TimeSupportLocator();

    /**

     * Return the singleton instance.

     * 

     * @return the singleton instance

     */

    public static TimeSupportLocator getInstance() {

        return INSTANCE;

    }

    /**

     * Return the Locator's name.

     * 

     * @return a String with the Locator's name

     */

    public final String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to the TimeSupportManager.

     * 

     * @return a reference to the TimeSupportManager

     * @throws LocatorException

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

     *             instantiated

     * @see Locator#get(String)

     */

    public static TimeSupportManager getManager() throws LocatorException {

        return (TimeSupportManager) getInstance().get(MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the TimeSupportManager interface.

     * 

     * @param clazz

     *            implementing the TimeSupportManager interface

     */

    public static void registerManager(

        Class<? extends TimeSupportManager> clazz) {

        getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

import org.gvsig.tools.lang.Cloneable;

/**

 * <p>

 * It defines a partial time that does not support every datetime field,

 * and is thus a local time. It cannot be compared to a {@link RelativeInstant},

 * as it does not fully specify an instant in time. 

 * </p>

 * <p>

 * The time it does specify is a local time, and does not include a time zone. 

 * An AbsoluteInstant supports a subset of the fields on the chronology.

 * </p> 

 * <p>

 * A huge part of the documentation of this class has been retrieved

 * from the joda-time library.

 * </p>

 * 

 * @see http://joda-time.sourceforge.net

 * @see https://gvsig.org/web/projects/gvsig-desktop/docs/devel/org-gvsig-sensors/1-0.0/analysis-and-design/detailed-view/time-support/libraries/org-gvsig-timesupport-lib

 * 

 * @author gvSIG team

 * @version $Id$

 */

public interface AbsoluteInstant extends Instant, Cloneable{

    /**

     * Gets the number of fields in this absolute instant.     

     * @return 

     *          the field count

     */

    public int size();

    /**

     * Gets the field type at the specified index.

     * @param index 

     *          the index to retrieve

     * @return 

     *          the field at the specified index

     */

    public AbsoluteInstantType getFieldType(int index);

    /**

     * Gets the value of the field at the specifed index.

     * @param index 

     *          the index

     * @return the value

     * @throws IndexOutOfBoundsException if the index is invalid

     */

    public int getValue(int index);

    /**

     * Gets the number of years of this absolute instant. 

     * @return

     *          the number of years

     */

    public int getYears();

    /**

     * Gets the number of months of this absolute instant. 

     * @return

     *          the number of months

     */

    public int getMonths();

    /**

     * Gets the number of weeks of this absolute instant. 

     * @return

     *          the number of weeks

     */

    public int getWeeks();

    /**

     * Gets the number of days of this absolute instant. 

     * @return

     *          the number of days

     */

    public int getDays();

    /**

     * Gets the number of hours of this absolute instant. 

     * @return

     *          the number of hours

     */

    public int getHours();

    /**

     * Gets the number of minutes of this absolute instant. 

     * @return

     *          the number of minutes

     */

    public int getMinutes();

    /**

     * Gets the number of seconds of this absolute instant. 

     * @return

     *          the number of seconds

     */

    public int getSeconds();

    /**

     * Gets the number of millis of this absolute instant. 

     * @return

     *          the number of millis

     */

    public int getMillis();

    /**

     * Gets the duration of the instant. It returns a duration assuming a 365

     * days year, 12 months year, 30 days month, 7 day week, 24 hour day, 60 minute hour,

     * 60 second minute and 1000 millis second. 

     * @return

     *          a duration equivalent to this instant from the time 0

     */

    public Duration toStandardDuration();

    /**

     * Gets a copy of this instance with the specified period take away.

     * If the amount is zero or null, then <code>this</code> is returned.     *

     * @param period  

     *          the period to reduce this instant by

     * @return 

     *          a copy of this instance with the period taken away

     * @throws ArithmeticException if the new instant exceeds the capacity of a long

     */

    public AbsoluteInstant minus(AbsoluteInterval interval);

    /**

     * Gets a copy of this instance with the specified period added.

     * If the amount is zero or null, then <code>this</code> is returned.

     *

     * @param period

     *          the duration to add to this one, null means zero

     * @return

     *          a copy of this instance with the period added

     * @throws ArithmeticException if the new instant exceeds the capacity of a long

     */

    public AbsoluteInstant plus(AbsoluteInterval interval);     

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.DataTypesManager;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

/**

 * Library for API initialization and configuration.

 * 

 * @author gvSIG team

 * @version $Id$

 */

public class TimeSupportLibrary extends AbstractLibrary {

    @Override

    protected void doInitialize() throws LibraryException {

        // Do nothing

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        // Validate there is any implementation registered.

        TimeSupportManager manager = TimeSupportLocator.getManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                TimeSupportLocator.MANAGER_NAME, TimeSupportLocator

                    .getInstance());

        }       

    }

}

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

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

 *

 */

package org.gvsig.timesupport;

/**

 * <p>

 * An Instant represents a position in a time scale. In practice, 

 * an instant is an interval whose duration is less than the resolution

 * of the time scale.

 * </p>

 * <p>All the Instant subclasses have to be immutable and have to 

 * provide a Chronology as well. All standard Chronology classes are

 * also immutable.

 * </p>

 * <p>

 * A huge part of the documentation of this class has been retrieved