com.nmote.iim4j.srs.SubjectReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nmote-iim4j Show documentation
IIM4J allows Java programmers to read, write and process IPTC IIM version 4 files.
The newest version!
/*
 * Copyright (c) Nmote Ltd. 2004-2015. All rights reserved.
 * See LICENSE doc in a root of project folder for additional information.
 */

package com.nmote.iim4j.srs;

import java.io.Serializable;

import com.nmote.iim4j.About;

/**
 * SubjectReference
 */
public class SubjectReference implements Serializable, Comparable {

	private static final long serialVersionUID = About.SERIAL_VERSION_UID;

	private static String toIPTCHelper(String s) {
		String result;
		if (s != null) {
			int idx = s.lastIndexOf(':');
			if (idx != -1) {
				result = s.substring(idx + 1);
			} else {
				result = s;
			}
		} else {
			result = "";
		}
		return result;
	}

	public SubjectReference(String number) {
		if (number.length() != 8) {
			throw new IllegalArgumentException("Subject reference length not equal 8: " + number);
		}
		this.number = number;
	}

	public int compareTo(SubjectReference ref) {
		return this.number.compareTo(ref.number);
	}

	public boolean equals(Object obj) {
		return obj == this
				|| (obj instanceof SubjectReference && ((SubjectReference) obj).getNumber().equals(getNumber()));
	}

	public String getNumber() {
		return number;
	}

	public String getSubjectDetailNumber() {
		return number.substring(5, 8);
	}

	public String getSubjectMatterNumber() {
		return number.substring(2, 5);
	}

	public String getSubjectNumber() {
		return number.substring(0, 2);
	}

	public int hashCode() {
		return number.hashCode();
	}

	public boolean isSubjectDetailDefined() {
		return !"000".equals(getSubjectDetailNumber());
	}

	public boolean isSubjectMatterDefined() {
		return !"000".equals(getSubjectMatterNumber());
	}

	/**
	 * Formats an IPTC string for this reference using information obtained from
	 * Subject Reference System.
	 *
	 * @param srs
	 *            reference subject reference system
	 * @return IPTC formatted reference
	 */
	public String toIPTC(SubjectReferenceSystem srs) {
		StringBuffer b = new StringBuffer();
		b.append("IPTC:");
		b.append(getNumber());
		b.append(":");
		if (getNumber().endsWith("000000")) {
			b.append(toIPTCHelper(srs.getName(this)));
			b.append("::");
		} else if (getNumber().endsWith("000")) {
			b.append(toIPTCHelper(srs.getName(srs.get(getNumber().substring(0, 2) + "000000"))));
			b.append(":");
			b.append(toIPTCHelper(srs.getName(this)));
			b.append(":");
		} else {
			b.append(toIPTCHelper(srs.getName(srs.get(getNumber().substring(0, 2) + "000000"))));
			b.append(":");
			b.append(toIPTCHelper(srs.getName(srs.get(getNumber().substring(0, 5) + "000"))));
			b.append(":");
			b.append(toIPTCHelper(srs.getName(this)));
		}
		return b.toString();
	}

	public String toString() {
		return number.toString();
	}

	protected String number;
}