io.github.qudtlib.model.Namespace Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qudtlib-model Show documentation
There is a newer version: 6.7.0
package io.github.qudtlib.model;

/** Encapsulates an iri and the prefix that is used to abbreviate it. */
public class Namespace {
    private final String abbreviationPrefix;
    private final String baseIri;

    /**
     * Constructs a namespace instace with specified baseIri and abbreviation prefix. For example,
     *
     *      *     Namespace rdf = Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#", "rdf");
     * 
     *
     * will provide abbreviation/expansion of IRIs in the RDF namespace.
     *
     * @param baseIri the base IRI of the namespece, e.g.
     *     "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
     * @param abbreviationPrefix the abbreviation prefix to use, e.g. "rdf"
     */
    public Namespace(String baseIri, String abbreviationPrefix) {
        this.abbreviationPrefix = abbreviationPrefix;
        this.baseIri = baseIri;
    }

    /**
     * Returns the string used to abbreviate IRIs in this namespace.
     *
     * @return
     */
    public String getAbbreviationPrefix() {
        return abbreviationPrefix;
    }

    /**
     * Returns the base IRI of the namespace.
     *
     * @return
     */
    public String getBaseIri() {
        return baseIri;
    }

    /**
     * Returns an abbreviated IRI if the specified iri starts with the baseIri; the unchanged input
     * String otherwise;
     *
     * @param iri
     * @return
     */
    public String abbreviate(String iri) {
        if (isFullNamespaceIri(iri)) {
            return this.abbreviationPrefix + ":" + iri.substring(this.baseIri.length());
        }
        return new String(iri);
    }

    public String expand(String abbreviatedIri) {
        if (isAbbreviatedNamespaceIri(abbreviatedIri)) {
            return this.baseIri + abbreviatedIri.substring(this.abbreviationPrefix.length() + 1);
        }
        return new String(abbreviatedIri);
    }

    /**
     * Returns true if the specified abbreviatedIri starts with the namespace's abbreviation prefix.
     */
    public boolean isAbbreviatedNamespaceIri(String abbreviatedIri) {
        return abbreviatedIri.startsWith(this.abbreviationPrefix + ':');
    }

    /** Returns true if the specified iri starts with the namespace's baseIri. */
    public boolean isFullNamespaceIri(String iri) {
        return iri.startsWith(this.baseIri);
    }

    /**
     * Prepends the namespace's baseIri to the specified localName.
     *
     * @param localName
     * @return
     */
    public String makeIriInNamespace(String localName) {
        return this.baseIri + localName;
    }

    public String getLocalName(String fullIri) {
        return fullIri.replaceFirst(this.baseIri, "");
    }
}