org.integratedmodelling.engine.time.literals.PeriodValue Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (C) 2007, 2015:
*
* - Ferdinando Villa
* - integratedmodelling.org
* - any other authors listed in @author annotations
*
* All rights reserved. This file is part of the k.LAB software suite,
* meant to enable modular, collaborative, integrated
* development of interoperable data and model components. For
* details, see http://integratedmodelling.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Affero General Public License
* Version 3 or 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
* Affero General Public License for more details.
*
* You should have received a copy of the Affero General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* The license is also available at: https://www.gnu.org/licenses/agpl.html
*******************************************************************************/
package org.integratedmodelling.engine.time.literals;
import java.util.Iterator;
import org.integratedmodelling.api.knowledge.IConcept;
import org.integratedmodelling.api.lang.IParseable;
import org.integratedmodelling.api.metadata.IMetadata;
import org.integratedmodelling.api.modelling.IDirectObservation;
import org.integratedmodelling.api.modelling.IExtent;
import org.integratedmodelling.api.modelling.IObservableSemantics;
import org.integratedmodelling.api.modelling.IObserver;
import org.integratedmodelling.api.modelling.IScale;
import org.integratedmodelling.api.modelling.IScale.Index;
import org.integratedmodelling.api.modelling.IScale.Locator;
import org.integratedmodelling.api.modelling.ITopologicallyComparable;
import org.integratedmodelling.api.modelling.storage.IStorage;
import org.integratedmodelling.api.space.ISpatialExtent;
import org.integratedmodelling.api.time.ITemporalExtent;
import org.integratedmodelling.api.time.ITimeDuration;
import org.integratedmodelling.api.time.ITimeInstant;
import org.integratedmodelling.api.time.ITimePeriod;
import org.integratedmodelling.collections.Pair;
import org.integratedmodelling.common.configuration.KLAB;
import org.integratedmodelling.common.knowledge.Observation;
import org.integratedmodelling.common.vocabulary.NS;
import org.integratedmodelling.exceptions.KlabException;
import org.joda.time.Interval;
public class PeriodValue extends Observation // inheritance graph prevents us from specifying
//
implements ITimePeriod, IParseable {
Interval value;
@Override
public boolean equals(Object o) {
return (o instanceof PeriodValue && ((PeriodValue) o).value.equals(value)) ||
(o instanceof Interval && o.equals(value));
}
@Override
public int hashCode() {
return value.hashCode();
};
public void parse(String s) {
/* TODO literal is two dates separated by a pound sign */
}
@Override
public int[] getDimensionSizes() {
return new int[] { (int) getMultiplicity() };
}
@Override
public int[] getDimensionOffsets(int linearOffset, boolean rowFirst) {
return new int[] { linearOffset };
}
@Override
public IConcept getType() {
return getObservable().getType();
}
public PeriodValue(Interval interval) {
value = interval;
}
public PeriodValue(String s) throws KlabException {
parse(s);
}
public PeriodValue(long x, long x2) {
this(new Interval(x, x2));
}
protected Interval getValue() {
// simple wrapper for casting for consistency
return value;
}
@Override
public String toString() {
return value.toString();
}
@Override
public Object clone() {
return new PeriodValue(getInterval());
}
public Interval getInterval() {
return value;
}
//
// @Override
// public boolean is(Object other) {
// if (!other.getClass().equals(getClass())) {
// return false;
// }
// return ((PeriodValue) other).getStart().equals(getStart())
// && ((PeriodValue) other).getEnd().equals(getEnd());
// }
@Override
public String asText() {
// ??
return toString();
}
/**
* Does this time period contain the time instant?
*
* (t,t+1] Semantics:
* This class modifies the behavior of the underlying Joda Interval (and most interval semantics)
* in that the start value is EXCLUSIVE and the end value is INCLUSIVE.
*
* This is to avoid circular-dependency problems during observation.
*
* @param time
* @return true if contained
*/
@Override
public boolean contains(ITimeInstant time) {
long millisInstant = time.getMillis();
return contains(millisInstant);
}
/**
* @see #contains(ITimeInstant)
*/
@Override
public boolean contains(long millisInstant) {
long thisStart = getInterval().getStartMillis();
long thisEnd = getInterval().getEndMillis();
return (millisInstant > thisStart && millisInstant <= thisEnd);
}
@Override
public double getCoveredExtent() {
// TODO Auto-generated method stub
return 0;
}
@Override
public boolean endsBefore(ITimeInstant instant) {
return (getEnd().compareTo(instant) < 0);
}
@Override
public boolean endsBefore(ITemporalExtent other) {
return (getEnd().compareTo(other.getStart()) < 0);
}
@Override
public boolean overlaps(ITemporalExtent other) {
return (getStart().compareTo(other.getEnd()) < 0) && (getEnd().compareTo(other.getStart()) > 0);
}
@Override
public ITimeInstant getStart() {
return new TimeValue(getValue().getStartMillis());
}
@Override
public ITimeInstant getEnd() {
return new TimeValue(getValue().getEndMillis());
}
@Override
public ITemporalExtent getExtent(int stateIndex) {
if (stateIndex != 0) {
return null;
}
return this;
}
@Override
public IConcept getDomainConcept() {
return KLAB.c(NS.TIME_DOMAIN);
}
// @Override
// public IProperty getCoverageProperty() {
// return KLAB.p(NS.TEMPORAL_EXTENT_PROPERTY);
// }
@Override
public ITimePeriod collapse() {
return this;
}
@Override
public boolean isCovered(int stateIndex) {
// TODO Auto-generated method stub
return false;
}
@Override
public IExtent merge(IExtent extent, boolean force) throws KlabException {
// TODO Auto-generated method stub
return null;
}
@Override
public Pair, Double> checkCoverage(ITopologicallyComparable obj)
throws KlabException {
// TODO Auto-generated method stub
return null;
}
@Override
public boolean isConsistent() {
// TODO Auto-generated method stub
return false;
}
@Override
public boolean isEmpty() {
// TODO Auto-generated method stub
return false;
}
@Override
public long getValueCount() {
return 1;
}
@Override
public IObserver getObserver() {
return null;
}
@Override
public boolean isSpatiallyDistributed() {
return false;
}
@Override
public boolean isTemporallyDistributed() {
return true;
}
@Override
public boolean isTemporal() {
return true;
}
@Override
public boolean isSpatial() {
return false;
}
@Override
public ISpatialExtent getSpace() {
return null;
}
@Override
public ITemporalExtent getTime() {
return this;
}
@Override
public IMetadata getMetadata() {
return null;
}
@Override
public long getMultiplicity() {
return 1;
}
@Override
public ITemporalExtent intersection(IExtent other) throws KlabException {
// TODO Auto-generated method stub
return null;
}
@Override
public ITemporalExtent union(IExtent other) throws KlabException {
if (!(other instanceof ITemporalExtent) || !overlaps(other)) {
return null;
}
ITimeInstant otherStart = ((ITemporalExtent) other).getStart();
ITimeInstant otherEnd = ((ITemporalExtent) other).getStart();
long start = otherStart.compareTo(getStart()) < 0 ? otherStart.getMillis() : getValue()
.getStartMillis();
long end = otherEnd.compareTo(getEnd()) > 0 ? otherEnd.getMillis() : getValue().getEndMillis();
return new PeriodValue(start, end);
}
@Override
public boolean contains(IExtent other) throws KlabException {
if (!(other instanceof ITemporalExtent)) {
return false;
}
return contains(((ITemporalExtent) other).getStart()) && contains(((ITemporalExtent) other).getEnd());
}
@Override
public boolean overlaps(IExtent other) throws KlabException {
if (!(other instanceof ITemporalExtent)) {
return false;
}
return overlaps((ITemporalExtent) other);
}
@Override
public boolean intersects(IExtent other) throws KlabException {
if (!(other instanceof ITemporalExtent)) {
return false;
}
// TODO
return false;
}
@Override
public ITopologicallyComparable union(ITopologicallyComparable other)
throws KlabException {
// TODO Auto-generated method stub
return null;
}
@Override
public ITopologicallyComparable intersection(ITopologicallyComparable other)
throws KlabException {
// TODO Auto-generated method stub
return null;
}
@Override
public IScale getScale() {
// TODO Auto-generated method stub
return null;
}
@Override
public Object getValue(int index) {
// TODO Auto-generated method stub
return null;
}
@Override
public Iterator