org.swrlapi.builtins.temporal.SWRLBuiltInLibraryImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swrlapi Show documentation
Show all versions of swrlapi Show documentation
Java API for working with SWRL rules and SQWRL queries
The newest version!
package org.swrlapi.builtins.temporal;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLDataPropertyAssertionAxiom;
import org.semanticweb.owlapi.model.OWLIndividual;
import org.semanticweb.owlapi.model.OWLLiteral;
import org.semanticweb.owlapi.model.OWLObjectPropertyAssertionAxiom;
import org.swrlapi.builtins.AbstractSWRLBuiltInLibrary;
import org.swrlapi.builtins.SWRLBuiltInBridge;
import org.swrlapi.builtins.arguments.SWRLBuiltInArgument;
import org.swrlapi.builtins.arguments.SWRLLiteralBuiltInArgument;
import org.swrlapi.builtins.arguments.SWRLNamedIndividualBuiltInArgument;
import org.swrlapi.exceptions.InvalidSWRLBuiltInArgumentException;
import org.swrlapi.exceptions.SWRLBuiltInException;
import org.swrlapi.exceptions.SWRLBuiltInLibraryException;
import org.swrlapi.literal.XSDDate;
import org.swrlapi.literal.XSDDateTime;
import java.math.BigInteger;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* Implementation library for SWRL temporal built-ins.
*/
public class SWRLBuiltInLibraryImpl extends AbstractSWRLBuiltInLibrary
{
private static final String PREFIX = "temporal";
private static final String NAMESPACE = "http://swrl.stanford.edu/ontologies/built-ins/3.3/temporal.owl#";
private static final String[] BUILT_IN_NAMES = { "notEquals", "notIntersects", "notStarts", "overlappedBy",
"contains", "equals", "intersects", "finishedBy", "notDurationLessThanOrEqualTo", "notStartedBy", "notFinishedBy",
"starts", "notContains", "notOverlaps", "durationLessThanOrEqualTo", "duration", "notFinishes", "metBy",
"notDurationEqualTo", "before", "startedBy", "notMeets", "durationGreaterThanOrEqualTo", "notDuring",
"notOverlappedBy", "during", "notDurationLessThan", "notBefore", "meets", "notDurationGreaterThan",
"notDurationGreaterThanOrEqualTo", "add", "finishes", "notAfter", "durationEqualTo", "overlaps",
"durationGreaterThan", "durationLessThan", "after", "notMetBy" };
private static final String TemporalEquals = PREFIX + ":" + "equals";
private static final String TemporalAfter = PREFIX + ":" + "after";
private static final String TemporalBefore = PREFIX + ":" + "before";
private static final String TemporalMeets = PREFIX + ":" + "meets";
private static final String TemporalMetBy = PREFIX + ":" + "metBy";
private static final String TemporalOverlaps = PREFIX + ":" + "overlaps";
private static final String TemporalOverlappedBy = PREFIX + ":" + "overlappedBy";
private static final String TemporalContains = PREFIX + ":" + "contains";
private static final String TemporalDuring = PREFIX + ":" + "during";
private static final String TemporalStarts = PREFIX + ":" + "starts";
private static final String TemporalStartedBy = PREFIX + ":" + "startedBy";
private static final String TemporalFinishes = PREFIX + ":" + "finishes";
private static final String TemporalFinishedBy = PREFIX + ":" + "finishedBy";
private static final String TemporalIntersects = PREFIX + ":" + "intersects";
private static final String ExtendedPropositionClassName = NAMESPACE + "ExtendedProposition";
private static final String ValidInstantClassName = NAMESPACE + "ValidInstant";
private static final String ValidPeriodClassName = NAMESPACE + "ValidPeriod";
private static final String GranularityClassName = NAMESPACE + "Granularity";
private static final String HasValidTimePropertyName = NAMESPACE + "hasValidTime";
private static final String HasTimePropertyName = NAMESPACE + "hasTime";
private static final String HasStartTimePropertyName = NAMESPACE + "hasStartTime";
private static final String HasFinishTimePropertyName = NAMESPACE + "hasFinishTime";
@NonNull private final Temporal temporal;
public SWRLBuiltInLibraryImpl()
{
super(PREFIX, NAMESPACE, new HashSet<>(Arrays.asList(BUILT_IN_NAMES)));
this.temporal = new Temporal(new XSDDateTimeStringProcessor());
this.temporal.setNow();
}
@Override public void reset() throws SWRLBuiltInLibraryException
{
this.temporal.setNow();
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean equals(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalEquals, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean before(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalBefore, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean after(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalAfter, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean meets(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalMeets, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean metBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalMetBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean overlaps(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalOverlaps, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean overlappedBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalOverlappedBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean contains(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalContains, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean during(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalDuring, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean starts(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalStarts, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean startedBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalStartedBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean finishes(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalFinishes, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean finishedBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalFinishedBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean intersects(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return temporalOperation(TemporalIntersects, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notIntersects(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalIntersects, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notEquals(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalEquals, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notBefore(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalBefore, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notAfter(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalAfter, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notMeets(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalMeets, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notMetBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalMetBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notOverlaps(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalOverlaps, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notOverlappedBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalOverlappedBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notContains(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalContains, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notDuring(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalDuring, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notStarts(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalStarts, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notStartedBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalStartedBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notFinishes(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalFinishes, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notFinishedBy(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !temporalOperation(TemporalFinishedBy, arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notDurationLessThan(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !durationLessThan(arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notDurationLessThanOrEqualTo(@NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
return !durationLessThanOrEqualTo(arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notDurationEqualTo(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
return !durationEqualTo(arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notDurationGreaterThan(@NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
return !durationGreaterThan(arguments);
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean notDurationGreaterThanOrEqualTo(@NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
return !durationGreaterThanOrEqualTo(arguments);
}
/**
* Accepts either three or four arguments. Returns true if the first duration argument is equal to the difference
* between two timestamps at the granularity specified by the final argument. The timestamps are specified as either a
* mixture of two ValidInstant or datetime arguments or in single ValidPeriod argument. If the duration argument is
* unbound, it is assigned to the time difference between the two timestamps.
*
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean duration(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
long operationResult;
checkNumberOfArgumentsInRange(3, 4, arguments.size());
checkForUnboundNonFirstArguments(arguments);
try {
int numberOfArguments = arguments.size();
if (numberOfArguments == 3) {
int granularity = getBuiltInArgumentAsAGranularity(2, arguments);
Period period = getArgumentAsAPeriod(1, arguments, granularity);
operationResult = period.duration(granularity);
} else { // 4 arguments
int granularity = getBuiltInArgumentAsAGranularity(3, arguments);
Instant i1 = getArgumentAsAnInstant(1, arguments, granularity);
Instant i2 = getArgumentAsAnInstant(2, arguments, granularity);
operationResult = i1.duration(i2, granularity);
}
} catch (TemporalException e) {
throw new SWRLBuiltInException(e.getMessage() == null ? "" : e.getMessage(), e);
}
if (isUnboundArgument(0, arguments)) {
SWRLLiteralBuiltInArgument resultArgument = createLiteralBuiltInArgument(operationResult);
arguments.get(0).asVariable().setBuiltInResult(resultArgument); // Bind the result to the first argument
return true;
} else {
long argument1 = convertArgumentToAPositiveLong(0, arguments);
return (argument1 == operationResult);
}
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean durationLessThan(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
checkNumberOfArgumentsInRange(3, 4, arguments.size());
checkForUnboundArguments(arguments);
List<@NonNull SWRLBuiltInArgument> newArguments = cloneArguments(arguments);
long argument1 = convertArgumentToALong(0, arguments);
if (newArguments.get(0).isVariable())
newArguments.get(0).asVariable().setUnbound();
duration(newArguments);
long operationResult = convertArgumentToALong(0, newArguments);
return argument1 < operationResult;
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean durationLessThanOrEqualTo(@NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
checkNumberOfArgumentsInRange(3, 4, arguments.size());
checkForUnboundArguments(arguments);
List<@NonNull SWRLBuiltInArgument> newArguments = cloneArguments(arguments);
long argument1 = convertArgumentToALong(0, arguments);
if (newArguments.get(0).isVariable())
newArguments.get(0).asVariable().setUnbound();
duration(newArguments);
long operationResult = convertArgumentToALong(0, newArguments);
return argument1 <= operationResult;
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean durationEqualTo(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
checkNumberOfArgumentsInRange(3, 4, arguments.size());
checkForUnboundArguments(arguments);
List<@NonNull SWRLBuiltInArgument> newArguments = cloneArguments(arguments);
long argument1 = convertArgumentToALong(0, arguments);
if (newArguments.get(0).isVariable())
newArguments.get(0).asVariable().setUnbound();
duration(newArguments);
long operationResult = convertArgumentToALong(0, newArguments);
return argument1 == operationResult;
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean durationGreaterThan(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
checkNumberOfArgumentsInRange(3, 4, arguments.size());
checkForUnboundArguments(arguments);
List<@NonNull SWRLBuiltInArgument> newArguments = cloneArguments(arguments);
long argument1 = convertArgumentToALong(0, arguments);
if (newArguments.get(0).isVariable())
newArguments.get(0).asVariable().setUnbound();
duration(newArguments);
long operationResult = convertArgumentToALong(0, newArguments);
return argument1 > operationResult;
}
/**
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean durationGreaterThanOrEqualTo(@NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
checkNumberOfArgumentsInRange(3, 4, arguments.size());
checkForUnboundArguments(arguments);
List<@NonNull SWRLBuiltInArgument> newArguments = cloneArguments(arguments);
long argument1 = convertArgumentToALong(0, arguments);
if (newArguments.get(0).isVariable())
newArguments.get(0).asVariable().setUnbound();
duration(newArguments);
long operationResult = convertArgumentToALong(0, newArguments);
return argument1 >= operationResult;
}
/**
* Returns true if the first timestamp argument is equal to the second timestamps argument plus the third count
* argument at the granularity specified by the fourth argument. The timestamps are specified as either a
* ValidInstant, or xsd:dateTime arguments. Arguments of type xsd:string are automatically converted to xsd:dateTime
* arguments. If the first argument is unbound, it is assigned the result of the addition.
*
* @param arguments The built-in arguments
* @return The result of the built-in
* @throws SWRLBuiltInException If an error occurs during processing
*/
public boolean add(@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
checkNumberOfArgumentsEqualTo(4, arguments.size());
checkForUnboundNonFirstArguments(arguments);
try {
long granuleCount = convertArgumentToALong(2, arguments);
int granularity = getBuiltInArgumentAsAGranularity(3, arguments);
Instant operationResult = getArgumentAsAnInstant(1, arguments, Temporal.FINEST);
operationResult.addGranuleCount(granuleCount, granularity);
if (isUnboundArgument(0, arguments)) {
SWRLLiteralBuiltInArgument resultArgument = createLiteralBuiltInArgument(
new XSDDateTime(operationResult.toString()));
arguments.get(0).asVariable().setBuiltInResult(resultArgument); // Bind the result to the first parameter.
return true;
} else {
Instant argument1 = getArgumentAsAnInstant(0, arguments, granularity);
return (argument1.equals(operationResult, Temporal.FINEST));
}
} catch (TemporalException e) {
throw new SWRLBuiltInException(e.getMessage() == null ? "" : e.getMessage(), e);
}
}
private boolean temporalOperation(@NonNull String operation, @NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
checkNumberOfArgumentsInRange(2, 4, arguments.size());
checkForUnboundArguments(arguments);
try {
int numberOfArguments = arguments.size();
boolean hasGranularityArgument = isBuiltInArgumentAGranularity(numberOfArguments - 1, arguments);
boolean has2nd3rdInstantArguments = hasGranularityArgument ? (numberOfArguments > 3) : (numberOfArguments > 2);
int granularity = hasGranularityArgument ?
getBuiltInArgumentAsAGranularity(numberOfArguments - 1, arguments) :
Temporal.FINEST;
Period p1 = getArgumentAsAPeriod(0, arguments, granularity);
Period p2 = has2nd3rdInstantArguments ?
getTwoInstantArgumentsAsAPeriod(1, 2, arguments, granularity) :
getArgumentAsAPeriod(1, arguments, granularity);
switch (operation) {
case TemporalEquals:
return p1.equals(p2, granularity);
case TemporalBefore:
return p1.before(p2, granularity);
case TemporalAfter:
return p1.after(p2, granularity);
case TemporalMeets:
return p1.meets(p2, granularity);
case TemporalMetBy:
return p1.met_by(p2, granularity);
case TemporalOverlaps:
return p1.overlaps(p2, granularity);
case TemporalOverlappedBy:
return p1.overlapped_by(p2, granularity);
case TemporalContains:
return p1.contains(p2, granularity);
case TemporalDuring:
return p1.during(p2, granularity);
case TemporalStarts:
return p1.starts(p2, granularity);
case TemporalStartedBy:
return p1.started_by(p2, granularity);
case TemporalFinishes:
return p1.finishes(p2, granularity);
case TemporalFinishedBy:
return p1.finished_by(p2, granularity);
case TemporalIntersects:
return p1.intersects(p2, granularity);
default:
throw new SWRLBuiltInException("internal error - unknown temporal operator " + operation);
}
} catch (TemporalException e) {
throw new SWRLBuiltInException(e.getMessage() == null ? "" : e.getMessage(), e);
}
}
@NonNull private Period getTwoInstantArgumentsAsAPeriod(int firstArgumentNumber, int secondArgumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments, int granularity)
throws SWRLBuiltInException, TemporalException
{
if (firstArgumentNumber >= arguments.size())
throw new InvalidSWRLBuiltInArgumentException(firstArgumentNumber, "out of range");
if (secondArgumentNumber >= arguments.size())
throw new InvalidSWRLBuiltInArgumentException(secondArgumentNumber, "out of range");
Instant i1 = getArgumentAsAnInstant(firstArgumentNumber, arguments, granularity);
Instant i2 = getArgumentAsAnInstant(secondArgumentNumber, arguments, granularity);
return new Period(this.temporal, i1, i2, granularity);
}
@NonNull private Period getArgumentAsAPeriod(int argumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments, int granularity)
throws SWRLBuiltInException, TemporalException
{
if (isArgumentALiteral(argumentNumber, arguments)) {
String datetimeString;
if (isArgumentAString(argumentNumber, arguments)) {
datetimeString = getArgumentAsAString(argumentNumber, arguments);
// rewriteStringArgumentAsADateOrDateTime(argumentNumber, arguments);
} else if (isArgumentADate(argumentNumber, arguments)) {
datetimeString = getArgumentAsADate(argumentNumber, arguments).getContent();
} else if (isArgumentADateTime(argumentNumber, arguments)) {
datetimeString = getArgumentAsADateTime(argumentNumber, arguments).getContent();
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"expecting an xsd:date, an xsd:dateTime, or an xsd:string containing a correctly-formatted XSD date or datetime value, got "
+ arguments.get(argumentNumber));
return new Period(this.temporal, datetimeString, datetimeString, granularity);
} else if (isArgumentAnOWLNamedIndividual(argumentNumber, arguments)) {
IRI individualIRI = getArgumentAsANamedIndividualIRI(argumentNumber, arguments);
if (isOWLIndividualOfType(individualIRI, createIRI(ValidInstantClassName))) {
Instant instant = validInstantIndividual2Instant(individualIRI, granularity);
return new Period(this.temporal, instant, granularity);
} else if (isOWLIndividualOfType(individualIRI, createIRI(ValidPeriodClassName))) {
return validPeriodIndividual2Period(individualIRI, granularity);
} else if (isOWLIndividualOfType(individualIRI, createIRI(ExtendedPropositionClassName))) {
return extendedPropositionIndividual2Period(individualIRI, granularity);
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"individual " + individualIRI + " is not a " + ValidInstantClassName + " or " + ValidPeriodClassName + " or "
+ ExtendedPropositionClassName);
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"expecting xsd:date or xsd:datetime or " + ValidInstantClassName + " or " + ValidPeriodClassName + " or "
+ ExtendedPropositionClassName + " individual, got " + arguments.get(argumentNumber));
}
@NonNull private Instant getArgumentAsAnInstant(int argumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments, int granularity)
throws SWRLBuiltInException, TemporalException
{
if (isArgumentALiteral(argumentNumber, arguments)) {
String datetimeString;
if (isArgumentAString(argumentNumber, arguments)) {
datetimeString = getArgumentAsAString(argumentNumber, arguments);
// rewriteStringArgumentAsADateOrDateTime(argumentNumber, arguments);
} else if (isArgumentADate(argumentNumber, arguments)) {
datetimeString = getArgumentAsADate(argumentNumber, arguments).getContent();
} else if (isArgumentADateTime(argumentNumber, arguments)) {
datetimeString = getArgumentAsADateTime(argumentNumber, arguments).getContent();
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"expecting an xsd:date, an xsd:dateTime, or an xsd:string containing a correctly-formatted XSD date or datetime value, got "
+ arguments.get(argumentNumber));
return new Instant(this.temporal, datetimeString, granularity);
} else if (isArgumentAnOWLNamedIndividual(argumentNumber, arguments)) {
IRI individualIRI = getArgumentAsANamedIndividualIRI(argumentNumber, arguments);
if (isOWLIndividualOfType(individualIRI, createIRI(ValidInstantClassName))) {
return validInstantIndividual2Instant(individualIRI, granularity);
} else if (isOWLIndividualOfType(individualIRI, createIRI(ExtendedPropositionClassName))) {
return extendedPropositionIndividual2Instant(individualIRI, granularity);
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"individual " + individualIRI + " is not a " + ValidInstantClassName + "or an "
+ ExtendedPropositionClassName);
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"expecting xsd:date or xsd:datetime or " + ValidInstantClassName + " or " + ExtendedPropositionClassName
+ " individual, got " + arguments.get(argumentNumber));
}
private int getBuiltInArgumentAsAGranularity(int argumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws TemporalException, SWRLBuiltInException
{
if (isArgumentALiteral(argumentNumber, arguments)) {
String granularityName = getArgumentAsAString(argumentNumber, arguments);
return Temporal.getIntegerGranularityRepresentation(granularityName);
} else if (isArgumentAnOWLNamedIndividual(argumentNumber, arguments)) {
SWRLNamedIndividualBuiltInArgument individualArgument = getArgumentAsANamedIndividual(argumentNumber, arguments);
IRI individualIRI = individualArgument.getIRI();
String fullName = individualIRI.toString();
String granularityName;
if (isOWLIndividualOfType(individualIRI, createIRI(GranularityClassName))) {
int hashIndex = fullName.indexOf('#');
if (hashIndex == -1)
granularityName = fullName;
else
granularityName = fullName.substring(hashIndex + 1);
return Temporal.getIntegerGranularityRepresentation(granularityName);
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"individual " + individualIRI + " is not a " + GranularityClassName);
} else
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
"expecting a " + GranularityClassName + " individual" + ", got " + arguments.get(argumentNumber));
}
private boolean isBuiltInArgumentAGranularity(int argumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
if (isArgumentAString(argumentNumber, arguments)) {
String granularityName = getArgumentAsAString(argumentNumber, arguments);
return Temporal.isValidGranularityString(granularityName);
} else if (isArgumentAnOWLNamedIndividual(argumentNumber, arguments)) {
IRI individualIRI = getArgumentAsANamedIndividualIRI(argumentNumber, arguments);
return isOWLIndividualOfType(individualIRI, createIRI(GranularityClassName));
} else
return false;
}
@NonNull private Instant validInstantIndividual2Instant(@NonNull IRI individualIRI, int granularity)
throws SWRLBuiltInException, TemporalException
{
String datetimeString = getDataPropertyValueAsAString(getBuiltInBridge(), individualIRI,
createIRI(HasTimePropertyName));
return new Instant(this.temporal, datetimeString, granularity);
}
@NonNull private Period validPeriodIndividual2Period(@NonNull IRI individualIRI, int granularity)
throws SWRLBuiltInException, TemporalException
{
String startDatetimeString = getDataPropertyValueAsAString(getBuiltInBridge(), individualIRI,
createIRI(HasStartTimePropertyName));
String finishDatetimeString = getDataPropertyValueAsAString(getBuiltInBridge(), individualIRI,
createIRI(HasFinishTimePropertyName));
return new Period(this.temporal, startDatetimeString, finishDatetimeString, granularity);
}
@NonNull private Period extendedPropositionIndividual2Period(@NonNull IRI extendedPropositionIRI, int granularity)
throws SWRLBuiltInException, TemporalException
{
IRI validTimeIRI = getObjectPropertyValueAsIRI(getBuiltInBridge(), extendedPropositionIRI,
createIRI(HasValidTimePropertyName));
if (isOWLIndividualOfType(validTimeIRI, createIRI(ValidPeriodClassName)))
return validPeriodIndividual2Period(validTimeIRI, granularity);
else
throw new SWRLBuiltInException("expecting valid period value for extended proposition " + extendedPropositionIRI);
}
@NonNull private Instant extendedPropositionIndividual2Instant(@NonNull IRI extendedPropositionIRI, int granularity)
throws SWRLBuiltInException, TemporalException
{
IRI validTimeIRI = getObjectPropertyValueAsIRI(getBuiltInBridge(), extendedPropositionIRI,
createIRI(HasValidTimePropertyName));
if (isOWLIndividualOfType(validTimeIRI, createIRI(ValidInstantClassName)))
return validInstantIndividual2Instant(validTimeIRI, granularity);
else
throw new SWRLBuiltInException(
"expecting valid instant value for extended proposition " + extendedPropositionIRI);
}
@NonNull private IRI getObjectPropertyValueAsIRI(@NonNull SWRLBuiltInBridge bridge, @NonNull IRI individualIRI,
@NonNull IRI propertyIRI)
{
Set<@NonNull OWLObjectPropertyAssertionAxiom> axioms = new HashSet<>(); // TODO Get assertions for this individual/property
OWLObjectPropertyAssertionAxiom axiom = axioms.toArray(new OWLObjectPropertyAssertionAxiom[0])[0];
OWLIndividual subject = axiom.getObject();
return subject.asOWLNamedIndividual().getIRI();
}
private boolean isOWLIndividualOfType(@NonNull IRI individualIRI, @NonNull IRI classIRI)
throws SWRLBuiltInLibraryException
{
return true; // TODO Implement isOWLIndividualOfType
}
@NonNull private String getDataPropertyValueAsAString(@NonNull SWRLBuiltInBridge bridge, @NonNull IRI individualIRI,
@NonNull IRI propertyIRI)
{
Set<@NonNull OWLDataPropertyAssertionAxiom> axioms = new HashSet<>(); // TODO Get assertions for this individual/property
OWLDataPropertyAssertionAxiom axiom = axioms.toArray(new OWLDataPropertyAssertionAxiom[0])[0];
OWLLiteral value = axiom.getObject();
return value.toString();
}
private long convertArgumentToALong(int argumentNumber, @NonNull List<@NonNull SWRLBuiltInArgument> arguments)
throws SWRLBuiltInException
{
BigInteger integerValue = getArgumentAsAnInteger(argumentNumber, arguments);
if (integerValue.compareTo(BigInteger.valueOf(Long.MAX_VALUE)) > 0
|| integerValue.compareTo(BigInteger.valueOf(Long.MIN_VALUE)) < 0)
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
makeInvalidArgumentTypeMessage(arguments.get(argumentNumber),
"value converted to xsd:long cannot be larger than " + Long.MAX_VALUE));
return integerValue.longValue();
}
/*
* For convenience, we allow users to supply xsd:date or xsd:dateTimes to built-ins as strings. We automatically
* rewrite those arguments to xsd:date or xsd:dateTimes. We must make sure that the generated date or dateTime We
* would like to rewrite but the XSD types require full time specifications - which may not match the partial
* specifications supplied.
*/
@SuppressWarnings("unused") private void rewriteStringArgumentAsADateOrDateTime(int argumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
String datetimeString = getArgumentAsAString(argumentNumber, arguments);
XSDDateTimeStringProcessor datetimeProcessor = new XSDDateTimeStringProcessor();
try {
if (datetimeProcessor.getFinestSpecifiedGranularity(datetimeString) < Temporal.HOURS) {
// If no finer than hours, assume it is xsd:date
XSDDate date = new XSDDate(datetimeProcessor.stripDatetimeString(datetimeString, Temporal.DAYS));
arguments.set(argumentNumber, createLiteralBuiltInArgument(date));
} else { // xsd:dateTime
XSDDateTime dateTime = new XSDDateTime(datetimeProcessor.normalizeDatetimeString(datetimeString));
arguments.set(argumentNumber, createLiteralBuiltInArgument(dateTime));
}
} catch (TemporalException e) {
throw new SWRLBuiltInException("invalid xsd:date or xsd:dateTime string " + datetimeString);
}
}
private long convertArgumentToAPositiveLong(int argumentNumber,
@NonNull List<@NonNull SWRLBuiltInArgument> arguments) throws SWRLBuiltInException
{
BigInteger integerValue = getArgumentAsAnInteger(argumentNumber, arguments);
if (integerValue.compareTo(BigInteger.ZERO) < 0)
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
makeInvalidArgumentTypeMessage(arguments.get(argumentNumber), "expecting positive xsd:integer"));
if (integerValue.compareTo(BigInteger.valueOf(Long.MAX_VALUE)) > 0)
throw new InvalidSWRLBuiltInArgumentException(argumentNumber,
makeInvalidArgumentTypeMessage(arguments.get(argumentNumber),
"value converted to xsd:long cannot be larger than " + Long.MAX_VALUE));
return integerValue.longValue();
}
@NonNull private IRI createIRI(@NonNull String fullName) throws SWRLBuiltInException
{
try {
return IRI.create(fullName);
} catch (RuntimeException e) {
throw new SWRLBuiltInException(
"error creating IRI from full prefix " + fullName + ": " + (e.getMessage() != null ? e.getMessage() : ""), e);
}
}
}