ai.grakn.Keyspace Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grakn-core Show documentation
There is a newer version: 1.4.3
/*
 * GRAKN.AI - THE KNOWLEDGE GRAPH
 * Copyright (C) 2018 Grakn Labs Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package ai.grakn;

import ai.grakn.engine.Jacksonisable;
import ai.grakn.exception.GraknTxOperationException;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;

import javax.annotation.CheckReturnValue;
import java.io.Serializable;
import java.util.regex.Pattern;

/**
 * 
 *     A {@link Keyspace}
 * 
 *
 * 
 *     A class which represents the unique name of a Grakn Knowledge Base
 * 
 *
 * @author Filipe Peliz Pinto Teixeira
 */
@AutoValue
public abstract class Keyspace implements Comparable, Serializable, Jacksonisable {
    private static final int MAX_LENGTH = 48;
    private static final long serialVersionUID = 2726154016735929123L;

    @JsonProperty("name")
    public abstract String getValue();

    @Override
    public int compareTo(Keyspace o) {
        if(equals(o)) return 0;
        return getValue().compareTo(o.getValue());
    }

    /**
     *
     * @param value The string which potentially represents a unique {@link Keyspace}
     * @return The matching {@link Keyspace}
     */
    @CheckReturnValue
    @JsonCreator
    public static Keyspace of(@JsonProperty("name") String value){
        if(!Pattern.matches("[a-z_][a-z_0-9]*", value) || value.length() > MAX_LENGTH) {
            throw GraknTxOperationException.invalidKeyspace(value);
        }
        return new AutoValue_Keyspace(value);
    }

    @Override
    public final String toString() {
        return getValue();
    }
}