owlapi-version5/api/src/main/java/org/semanticweb/owlapi/vocab/OWLFacet.java
/* 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 static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.asMap;
import static org.semanticweb.owlapi.util.OWLAPIStreamUtils.asSet;

import java.util.Map;
import java.util.Set;
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;

/**
 * Represents the facets that can be used for restricting a datatype.
 *
 * @author Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group
 * @see org.semanticweb.owlapi.model.OWLFacetRestriction
 * @see org.semanticweb.owlapi.model.OWLDatatypeRestriction
 * @since 2.0.0
 */
public enum OWLFacet implements HasShortForm, HasIRI, HasPrefixedName {
//@formatter:off
    /** LENGTH. */           LENGTH          (Namespaces.XSD, "length",          "length"), 
    /** MIN_LENGTH. */       MIN_LENGTH      (Namespaces.XSD, "minLength",       "minLength"), 
    /** MAX_LENGTH. */       MAX_LENGTH      (Namespaces.XSD, "maxLength",       "maxLength"), 
    /** PATTERN. */          PATTERN         (Namespaces.XSD, "pattern",         "pattern"), 
    /** MIN_INCLUSIVE. */    MIN_INCLUSIVE   (Namespaces.XSD, "minInclusive",    ">="), 
    /** MIN_EXCLUSIVE. */    MIN_EXCLUSIVE   (Namespaces.XSD, "minExclusive",    ">"), 
    /** MAX_INCLUSIVE. */    MAX_INCLUSIVE   (Namespaces.XSD, "maxInclusive",    "<="), 
    /** MAX_EXCLUSIVE. */    MAX_EXCLUSIVE   (Namespaces.XSD, "maxExclusive",    "<"), 
    /** TOTAL_DIGITS. */     TOTAL_DIGITS    (Namespaces.XSD, "totalDigits",     "totalDigits"), 
    /** FRACTION_DIGITS. */  FRACTION_DIGITS (Namespaces.XSD, "fractionDigits",  "fractionDigits"), 
    /** LANG_RANGE. */       LANG_RANGE      (Namespaces.RDF, "langRange",       "langRange");
//@formatter:on
    /**
     * All facet iris.
     */
    public static final Map<IRI, OWLFacet> FACET_IRIS = asMap(stream(), HasIRI::getIRI);
    private final IRI iri;
    private final String shortForm;
    private final String symbolicForm;
    private final String prefixedName;

    OWLFacet(Namespaces ns, String shortForm, String symbolicForm) {
        iri = IRI.create(ns.toString(), shortForm);
        this.shortForm = shortForm;
        this.symbolicForm = symbolicForm;
        prefixedName = ns.getPrefixName() + ':' + shortForm;
    }

    private static Stream<OWLFacet> stream() {
        return Stream.of(values());
    }

    /**
     * @return all facet iris
     */
    public static Set<IRI> getFacetIRIs() {
        return FACET_IRIS.keySet();
    }

    /**
     * @param iri facet IRI
     * @return facet for iri
     */
    public static OWLFacet getFacet(IRI iri) {
        checkNotNull(iri, "iri cannot be null");
        OWLFacet facet = FACET_IRIS.get(iri);
        if (facet == null) {
            throw new IllegalArgumentException("Unknown facet: " + iri);
        }
        return facet;
    }

    /**
     * Gets a facet by its short name.
     *
     * @param shortName The short name of the facet.
     * @return The facet or {@code null} if not facet by the specified name exists.
     */
    @Nullable
    public static OWLFacet getFacetByShortName(String shortName) {
        checkNotNull(shortName);
        return stream().filter(v -> v.getShortForm().equals(shortName)).findAny().orElse(null);
    }

    /**
     * @param symbolicName symbolic name for facet
     * @return facet for name
     */
    @Nullable
    public static OWLFacet getFacetBySymbolicName(String symbolicName) {
        return stream().filter(v -> v.getSymbolicForm().equals(symbolicName)).findAny()
            .orElse(null);
    }

    /**
     * @return all facets
     */
    public static Set<String> getFacets() {
        return asSet(stream().map(v -> v.getSymbolicForm()));
    }

    @Override
    public String getShortForm() {
        return shortForm;
    }

    @Override
    public IRI getIRI() {
        return iri;
    }

    /**
     * @return symbolic form
     */
    public String getSymbolicForm() {
        return symbolicForm;
    }

    @Override
    public String toString() {
        return getShortForm();
    }

    @Override
    public String getPrefixedName() {
        return prefixedName;
    }
}
