org.hisp.dhis.model.IdScheme Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dhis2-java-client Show documentation
DHIS 2 API client for Java.
There is a newer version: 2.0.4
package org.hisp.dhis.model;

import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang3.Validate;

public class IdScheme
{
    public static final IdScheme UID = new IdScheme( ObjectProperty.UID );

    public static final IdScheme CODE = new IdScheme( ObjectProperty.CODE );

    private static final Pattern ATTRIBUTE_ID_SCHEME_PATTERN = Pattern
        .compile( "^(ATTRIBUTE|attribute):([a-zA-Z]{1}[a-zA-Z0-9]{10})$" );

    private static final Pattern UID_PATTERN = Pattern.compile( "^[a-zA-Z]{1}[a-zA-Z0-9]{10}$" );

    private final ObjectProperty objectProperty;

    private final String attribute;

    // -------------------------------------------------------------------------
    // Constructors
    // -------------------------------------------------------------------------

    private IdScheme( ObjectProperty objectProperty )
    {
        this.objectProperty = objectProperty;
        this.attribute = null;
        Objects.requireNonNull( objectProperty );
    }

    private IdScheme( ObjectProperty objectProperty, String attribute )
    {
        this.objectProperty = objectProperty;
        this.attribute = attribute;
        Objects.requireNonNull( objectProperty );
        Objects.requireNonNull( attribute );
    }

    public IdScheme( String idScheme )
    {
        IdScheme scheme = IdScheme.createIdScheme( idScheme );
        this.objectProperty = scheme.objectProperty;
        this.attribute = scheme.attribute;
        Objects.requireNonNull( objectProperty );
    }

    // -------------------------------------------------------------------------
    // Create methods
    // -------------------------------------------------------------------------

    /**
     * Creates an {@link IdScheme} with object property ATTRIBUTE for the given
     * attribute ID (UID). The attribute must be a valid UID and cannot be null.
     *
     * @param attribute the attribute ID (UID).
     * @return an {@link IdScheme}.
     */
    public static IdScheme createAttributeIdScheme( String attribute )
    {
        Validate.isTrue( isValidUid( attribute ) );
        return new IdScheme( ObjectProperty.ATTRIBUTE, attribute );
    }

    /**
     * Creates an {@link IdScheme} based on the given string. The string can be
     * on the following formats:
     *
     * 
     * UID
     * CODE
     * ATTRIBUTE:{attribute-ID}
     * 
     *
     * @param idScheme the ID scheme string.
     * @return an {@link IdScheme}.
     * @throws IllegalArgumentException if the ID scheme string is invalid.
     */
    public static IdScheme createIdScheme( String idScheme )
    {
        if ( idScheme == null )
        {
            return null;
        }

        if ( ObjectProperty.UID.name().equalsIgnoreCase( idScheme ) )
        {
            return UID;
        }

        if ( ObjectProperty.CODE.name().equalsIgnoreCase( idScheme ) )
        {
            return CODE;
        }

        Matcher attributeMatcher = ATTRIBUTE_ID_SCHEME_PATTERN.matcher( idScheme );

        if ( attributeMatcher.matches() )
        {
            String attribute = attributeMatcher.group( 2 );

            return new IdScheme( ObjectProperty.ATTRIBUTE, attribute );
        }

        throw new IllegalArgumentException( String.format( "ID scheme is invalid: '%s'", idScheme ) );
    }

    /**
     * Indicates whether the given UID is valid.
     *
     * @param uid the UID.
     * @return true if the given UID is valid.
     */
    private static boolean isValidUid( String uid )
    {
        return uid != null && UID_PATTERN.matcher( uid ).matches();
    }

    // -------------------------------------------------------------------------
    // Get methods
    // -------------------------------------------------------------------------

    public ObjectProperty getObjectProperty()
    {
        return objectProperty;
    }

    public String getAttribute()
    {
        return attribute;
    }

    // -------------------------------------------------------------------------
    // Hash code and equals
    // -------------------------------------------------------------------------

    @Override
    public int hashCode()
    {
        return Objects.hash( objectProperty, attribute );
    }

    @Override
    public boolean equals( Object o )
    {
        if ( this == o )
        {
            return true;
        }

        if ( o == null || !getClass().isAssignableFrom( o.getClass() ) )
        {
            return false;
        }

        IdScheme other = (IdScheme) o;

        return Objects.equals( this.objectProperty, other.objectProperty ) &&
            Objects.equals( this.attribute, other.attribute );
    }

    /**
     * Returns a string representation of this {@link IdScheme}. Alias for
     * {@link IdScheme#toString()}.
     *
     * @return a string representation of this {@link IdScheme}.
     */
    public String name()
    {
        return this.toString();
    }

    /**
     * Returns a string representation of this {@link IdScheme}.
     *
     * @return a string representation of this {@link IdScheme}.
     */
    @Override
    public String toString()
    {
        if ( ObjectProperty.ATTRIBUTE == objectProperty )
        {
            return "attribute:" + attribute;
        }
        else
        {
            return objectProperty.name().toLowerCase();
        }

    }

    // -------------------------------------------------------------------------
    // ObjectProperty enum
    // -------------------------------------------------------------------------

    enum ObjectProperty
    {
        UID,
        CODE,
        ATTRIBUTE;
    }
}