/* This file is part of the OWL API.
* The contents of this file are subject to the LGPL License, Version 3.0.
* Copyright 2014, The University of Manchester
*
* 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, see http://www.gnu.org/licenses/.
*
* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */
package org.semanticweb.owlapi.vocab;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import org.semanticweb.owlapi.model.HasIRI;
import org.semanticweb.owlapi.model.HasPrefixedName;
import org.semanticweb.owlapi.model.HasShortForm;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.SWRLPredicate;
/**
* @author Matthew Horridge, The University Of Manchester, Medical Informatics Group
* @since 2.0.0
*/
public enum SWRLBuiltInsVocabulary implements SWRLPredicate, HasShortForm, HasIRI, HasPrefixedName {
//@formatter:off
/** EQUAL. */ EQUAL("equal", 2),
/** NOT_EQUAL. */ NOT_EQUAL("notEqual", 2),
/** LESS_THAN. */ LESS_THAN("lessThan", 2),
/** LESS_THAN_OR_EQUAL. */ LESS_THAN_OR_EQUAL("lessThanOrEqual", 2),
/** GREATER_THAN. */ GREATER_THAN("greaterThan", 2),
/** GREATER_THAN_OR_EQUAL. */ GREATER_THAN_OR_EQUAL("greaterThanOrEqual", 2),
/** ADD. */ ADD("add", -1),
/** SUBTRACT. */ SUBTRACT("subtract", 3),
/** MULTIPLY. */ MULTIPLY("multiply", -1),
/** DIVIDE. */ DIVIDE("divide", 3),
/** INTEGER_DIVIDE. */ INTEGER_DIVIDE("integerDivide", 3),
/** MOD. */ MOD("mod", 3),
/** POW. */ POW("pow", 3),
/** UNARY_MINUS. */ UNARY_MINUS("unaryMinus", 2),
/** UNARY_PLUS. */ UNARY_PLUS("unaryPlus", 2),
/** ABS. */ ABS("abs", 2),
/** CEILING. */ CEILING("ceiling", 2),
/** FLOOR. */ FLOOR("floor", 2),
/** ROUND. */ ROUND("round", 2),
/** ROUND_HALF_TO_EVEN. */ ROUND_HALF_TO_EVEN("roundHalfToEven", 2, 3),
/** SIN. */ SIN("sin", 2),
/** COS. */ COS("cos", 2),
/** TAN. */ TAN("tan", 2),
/** BOOLEAN_NOT. */ BOOLEAN_NOT("booleanNot", 2),
/** STRING_EQUALS_IGNORE_CASE. */STRING_EQUALS_IGNORE_CASE("stringEqualIgnoreCase", 2),
/** STRING_CONCAT. */ STRING_CONCAT("stringConcat", -1),
/** SUBSTRING. */ SUBSTRING("substring", 3),
/** STRING_LENGTH. */ STRING_LENGTH("stringLength", 2),
/** NORMALIZE_SPACE. */ NORMALIZE_SPACE("normalizeSpace", 2),
/** UPPER_CASE. */ UPPER_CASE("upperCase", 2),
/** LOWER_CASE. */ LOWER_CASE("lowerCase", 2),
/** TRANSLATE. */ TRANSLATE("translate", 4),
/** CONTAINS. */ CONTAINS("contains", 2),
/** CONTAINS_IGNORE_CASE. */ CONTAINS_IGNORE_CASE("containsIgnoreCase", 2),
/** STARTS_WITH. */ STARTS_WITH("startsWith", 2),
/** ENDS_WITH. */ ENDS_WITH("endsWith", 2),
/** SUBSTRING_BEFORE. */ SUBSTRING_BEFORE("substringBefore", 3),
/** SUBSTRING_AFTER. */ SUBSTRING_AFTER("substringAfter", 3),
/** MATCHES. */ MATCHES("matchesLax", 2),
/** REPLACE. */ REPLACE("replace", 4),
/** TOKENIZE. */ TOKENIZE("tokenize", 3),
/** YEAR_MONTH_DURATION. */ YEAR_MONTH_DURATION("yearMonthDuration", 5),
/** DAY_TIME_DURATION. */ DAY_TIME_DURATION("dayTimeDuration", 5),
/** DATE_TIME. */ DATE_TIME("dateTime", 5),
/** DATE. */ DATE("date", 5),
/** TIME. */ TIME("time", 5),
/** SUBTRACT_DATES. */ SUBTRACT_DATES("subtractDates", 3),
/** SUBTRACT_TIMES. */ SUBTRACT_TIMES("subtractTimes", 3),
/** RESOLVE_URI. */ RESOLVE_URI("resolveURI", 3),
/** ANY_URI. */ ANY_URI("anyURI", 7),
/** ADD_YEAR_MONTH_DURATIONS. */ ADD_YEAR_MONTH_DURATIONS("addYearMonthDurations", -1),
/** SUBTRACT_YEAR_MONTH_DURATIONS. */ SUBTRACT_YEAR_MONTH_DURATIONS("subtractYearMonthDurations", 3),
/** MULTIPLY_YEAR_MONTH_DURATIONS. */ MULTIPLY_YEAR_MONTH_DURATIONS("multiplyYearMonthDurations", 3),
/** DIVIDE_YEAR_MONTH_DURATIONS. */ DIVIDE_YEAR_MONTH_DURATIONS("divideYearMonthDurations", 3),
/** ADD_DAY_TIME_DURATIONS. */ ADD_DAY_TIME_DURATIONS("addDayTimeDurations", -1),
/** SUBTRACT_DAY_TIME_DURATIONS. */ SUBTRACT_DAY_TIME_DURATIONS("subtractDayTimeDurations", 3),
/** MULTIPLY_DAY_TIME_DURATIONS. */ MULTIPLY_DAY_TIME_DURATIONS("multiplyDayTimeDurations", 3),
/** DIVIDE_DAY_TIME_DURATIONS. */ DIVIDE_DAY_TIME_DURATIONS("divideDayTimeDurations", 3),
/** ADD_DAY_TIME_DURATION_TO_DATE_TIME. */ ADD_DAY_TIME_DURATION_TO_DATE_TIME("addDayTimeDurationToDateTime", 3),
/** SUBTRACT_YEAR_MONTH_DURATION_FROM_DATE_TIME. */ SUBTRACT_YEAR_MONTH_DURATION_FROM_DATE_TIME("subtractYearMonthDurationFromDateTime", 3),
/** SUBTRACT_DAY_TIME_DURATION_FROM_DATE_TIME. */ SUBTRACT_DAY_TIME_DURATION_FROM_DATE_TIME("subtractDayTimeDurationFromDateTime", 3),
/** ADD_YEAR_MONTH_DURATION_TO_DATE. */ ADD_YEAR_MONTH_DURATION_TO_DATE("addYearMonthDurationToDate", 3),
/** ADD_DAY_TIME_DURATION_TO_DATE. */ ADD_DAY_TIME_DURATION_TO_DATE("addDayTimeDurationToDate", 3),
/** SUBTRACT_YEAR_MONTH_DURATION_FROM_DATE. */ SUBTRACT_YEAR_MONTH_DURATION_FROM_DATE("subtractYearMonthDurationFromDate", 3),
/** SUBTRACT_DAY_TIME_DURATION_FROM_DATE. */ SUBTRACT_DAY_TIME_DURATION_FROM_DATE("subtractDayTimeDurationFromDate", 3),
/** ADD_DAY_TIME_DURATION_FROM_TIME. */ ADD_DAY_TIME_DURATION_FROM_TIME("addDayTimeDurationToTime", 3),
/** SUBTRACT_DAY_TIME_DURATION_FROM_TIME. */ SUBTRACT_DAY_TIME_DURATION_FROM_TIME("subtractDayTimeDurationFromTime", 3),
/** SUBTRACT_DATE_TIMES_YIELDING_YEAR_MONTH_DURATION. */ SUBTRACT_DATE_TIMES_YIELDING_YEAR_MONTH_DURATION("subtractDateTimesYieldingYearMonthDuration", 3),
/** SUBTRACT_DATE_TIMES_YIELDING_DAY_TIME_DURATION. */ SUBTRACT_DATE_TIMES_YIELDING_DAY_TIME_DURATION("subtractDateTimesYieldingDayTimeDuration", 3);
//@formatter:on
private final String shortName;
private final String prefixedName;
private final IRI iri;
// Arity of the predicate (-1 if infinite)
private final int minArity;
private final int maxArity;
SWRLBuiltInsVocabulary(String name, int arity) {
this(name, arity, arity);
}
SWRLBuiltInsVocabulary(String name, int minArity, int maxArity) {
shortName = name;
prefixedName = Namespaces.SWRLB.getPrefixName() + ':' + name;
iri = IRI.create(Namespaces.SWRLB.toString(), name);
this.minArity = minArity;
this.maxArity = maxArity;
}
/**
* Gets a builtin vocabulary value for a given IRI.
*
* @param iri The IRI
* @return The builtin vocabulary having the specified IRI, or {@code null} if there is no
* builtin vocabulary with the specified IRI
*/
@Nullable
public static SWRLBuiltInsVocabulary getBuiltIn(IRI iri) {
return Stream.of(values()).filter(v -> v.iri.equals(iri)).findAny().orElse(null);
}
@Override
public String getShortForm() {
return shortName;
}
@Override
public IRI getIRI() {
return iri;
}
/**
* Gets the minimum arity of this built in.
*
* @return The minimum arity of this built in
*/
public int getMinArity() {
return minArity;
}
/**
* Gets the maximum arity of this built in.
*
* @return The maximum arity of the built in or -1 if the arity is infinite
*/
public int getMaxArity() {
return maxArity;
}
@Override
public String getPrefixedName() {
return prefixedName;
}
}