ISAN.java

/*
 * Copyright (C) 2014 Jörg Prante
 *
 * 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 http://www.gnu.org/licenses
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * The interactive user interfaces in modified source and object code
 * versions of this program must display Appropriate Legal Notices,
 * as required under Section 5 of the GNU Affero General Public License.
 *
 */
package org.xbib.standardnumber;

import org.xbib.standardnumber.check.iso7064.MOD3736;

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

/**
 * ISO 15706 International Standard Audiovisual Number (ISAN)
 *
 * The International Standard Audiovisual Number (ISAN) is a unique identifier for
 * audiovisual works and related versions, similar to ISBN for books.
 *
 * It was developed within an ISO (International Organisation for Standardisation) TC46/SC9
 * working group. ISAN is managed and run by ISAN-IA.
 *
 * The ISAN standard (ISO standard 15706:2002 & ISO 15706-2) is recommended or required
 * as the audiovisual identifier of choice for producers, studios, broadcasters,
 * Internet media providers and video games publishers who need to encode, track, and
 * distribute video in a variety of formats.
 *
 * It provides a unique, internationally recognized and permanent reference number for each
 * audiovisual work and related versions registered in the ISAN system.
 *
 * ISAN identifies works throughout their entire life cycle from conception, to production,
 * to distribution and consumption.
 *
 * ISANs can be incorporated in both digital and physical media, such as theatrical
 * release prints, DVDs, publications, advertising, marketing materials and packaging,
 * as well as licensing contracts to uniquely identify works.
 *
 * The ISAN identifier is incorporated in many draft and final standards such as
 * AACS, DCI, MPEG, DVB, and ATSC.
 */
public class ISAN extends AbstractStandardNumber implements Comparable<ISAN>, StandardNumber {

    private static final Pattern PATTERN = Pattern.compile("[\\p{Alnum}\\-]{16,34}");

    private String value;

    private String formatted;

    private boolean versioned;

    @Override
    public String type() {
        return "isan";
    }

    @Override
    public int compareTo(ISAN isan) {
        return isan != null ? normalizedValue().compareTo(isan.normalizedValue()) : -1;
    }

    @Override
    public ISAN set(CharSequence value) {
        this.value = value != null ? value.toString() : null;
        return this;
    }

    @Override
    public ISAN createChecksum(boolean createWithChecksum) {
        return this;
    }

    @Override
    public ISAN normalize() {
        Matcher m = PATTERN.matcher(value);
        if (m.find()) {
            this.value = clean(value.substring(m.start(), m.end()));
            versioned = value.length() > 17;
        }
        return this;
    }

    @Override
    public boolean isValid() {
        return value != null && !value.isEmpty() && check();
    }

    @Override
    public ISAN verify() throws NumberFormatException {
        if (value == null) {
            throw new NumberFormatException();
        }
        if (!check()) {
            throw new NumberFormatException("invalid checksum");
        }
        return this;
    }

    @Override
    public String normalizedValue() {
        return value;
    }

    @Override
    public String format() {
        return formatted;
    }

    public ISAN versioned() {
        this.versioned = true;
        return this;
    }

    @Override
    public ISAN reset() {
        this.value = null;
        this.formatted = null;
        this.versioned = false;
        return this;
    }

    private final static MOD3736 check = new MOD3736();

    private boolean check() {
        if (versioned) {
            int chk1 = value.length() >= 17 ? check.compute(value.substring(0,17)) : -1;
            int chk2 = value.length() >= 26 ? check.compute(value.substring(0,16) + value.substring(17,26)) : -1;
            if (chk1 != 1) {
                return false;
            }
            if (chk2 != 1) {
                return false;
            }
        } else {
            int chk = check.compute(value);
            if (chk != 1) {
                return false;
            }
        }
        return true;
    }

    private String clean(String value) {
        StringBuilder sb = new StringBuilder(value);
        int i = sb.indexOf("-");
        while (i >= 0) {
            sb.deleteCharAt(i);
            i = sb.indexOf("-");
        }
        i = sb.indexOf(" ");
        while (i >= 0) {
            sb.deleteCharAt(i);
            i = sb.indexOf(" ");
        }
        this.formatted = "ISAN "
                + (sb.length() < 4 ? sb :
                    sb.substring(0,4) + "-"
                + (sb.length() < 8 ? sb.substring(4) :
                    sb.substring(4,8) + "-"
                + (sb.length() < 12 ? sb.substring(8) :
                    sb.substring(8,12) + "-"
                + (sb.length() < 16 ? sb.substring(12) :
                    sb.substring(12,16) + "-"
                + (sb.length() < 17 ? sb.substring(16) :
                    sb.substring(16,17))))));
        if (sb.length() > 17) {
            this.formatted = this.formatted + "-"
                    + (sb.length() < 21 ? sb.substring(17) :
                      (sb.substring(17, 21) + "-"
                    + (sb.length() < 25 ? sb.substring(21) :
                      (sb.substring(21, 25)  + "-"
                    + (sb.length() < 26 ? sb.substring(25) :
                      sb.substring(25, 26))))));
        }
        return sb.toString();
    }
}