edu.stanford.protege.webprotege.crud.uuid.UuidSuffixSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-api Show documentation
The newest version!
package edu.stanford.protege.webprotege.crud.uuid;


import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.google.auto.value.AutoValue;
import edu.stanford.protege.webprotege.crud.EntityCrudKitId;
import edu.stanford.protege.webprotege.crud.EntityCrudKitSuffixSettings;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import static edu.stanford.protege.webprotege.crud.uuid.UuidSuffixSettings.TYPE_ID;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 13/08/2013
 * 
 *
 * 
 */
@AutoValue
@JsonTypeName(TYPE_ID)
public abstract class UuidSuffixSettings extends EntityCrudKitSuffixSettings {

    public static final String TYPE_ID = "Uuid";

    /**
     * A start char for local names.  Some UUIDs might start with a number.  Unfortunately, NCNames (non-colonised names)
     * in XML cannot start with numbers.  For everything apart from properties this is o.k. but for properties it means
     * that it might not be possible to save an ontology in RDF/XML.  We therefore prefix each local name with a valid
     * NCName start char - "R".  The character "R" was chosen so as not to encode the type into the name.  I initially
     * considered C for classes, P properties etc. however with punning this would get ugly.
     */
    public static final String BASE62_ID_PREFIX = "R";

    public static final String STARDARD_ID_PREFIX = "id-";

    protected static final String UUID_FORMAT = "uuidFormat";

    public static UuidSuffixSettings get() {
        return get(UuidFormat.BASE62);
    }

    @JsonCreator
    public static UuidSuffixSettings get(@JsonProperty(UUID_FORMAT) @Nullable UuidFormat format) {
        if(format == null) {
            return new AutoValue_UuidSuffixSettings(UuidFormat.BASE62);
        }
        else {
            return new AutoValue_UuidSuffixSettings(format);
        }
    }

    @JsonIgnore
    public EntityCrudKitId getKitId() {
        return UuidSuffixKit.getId();
    }

    @JsonProperty(UUID_FORMAT)
    @Nonnull
    public abstract UuidFormat getUuidFormat();

    @JsonIgnore
    @Nonnull
    public String getIdPrefix() {
        if(getUuidFormat().equals(UuidFormat.BASE62)) {
            return BASE62_ID_PREFIX;
        }
        else {
            return STARDARD_ID_PREFIX;
        }
    }
}