Ticket.java

/*
 * Copyright 2011 Luke Usherwood.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.bettyluke.tracinstant.data;

import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;

public class Ticket {

    private Map<String, String> m_Fields = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);

    private final int m_Number;

    public Ticket(int Number) {
        m_Number = Number;
    }

    public Ticket(Ticket original) {
        m_Number = original.m_Number;
        setFieldsFromTicket(original);
    }

    /** Set (or overwrite) our fields using those in the supplied ticket. */
    public final void setFieldsFromTicket(Ticket ticket) {
        if (m_Number != ticket.m_Number) {
            System.err.println("Ticket numbers don't match");
        }

        for (Entry<String, String> field : ticket.m_Fields.entrySet()) {
            m_Fields.put(field.getKey(), field.getValue()); // String from Ticket already interned
        }
    }

    public int getNumber() {
        return m_Number;
    }

    @Override
    public String toString() {
        return "Ticket " + m_Number + ", " + super.toString();
    }

    public void putField(String fieldName, String value) {
        if (value == null) {
            m_Fields.remove(fieldName);
        } else {
            m_Fields.put(fieldName, maybeIntern(value));
        }
    }

    public void remove(String fieldName) {
        m_Fields.remove(fieldName);
    }

    public final void setOrMergeField(String fieldName, String value) {
        String existing = m_Fields.get(fieldName);
        if (existing != null && !existing.equals(value)) {

            System.out.println("WARNING: field " + fieldName + " in ticket " + m_Number +
                    " is already set. Data will be merged.");
            value = existing + "\n" + value;
        }
        m_Fields.put(fieldName, maybeIntern(value));
    }

    private static String maybeIntern(String value) {
        return value.length() < 200 ? value.intern() : value;
    }

    public Collection<String> getFieldNames() {
        return Collections.unmodifiableSet(m_Fields.keySet());
    }

    public String getValue(String fieldName) {
        String result = m_Fields.get(fieldName);
        if (result == null || result.isEmpty()) {
            String newResult = tryAliases(fieldName);
            if (newResult != null) {
                return newResult;
            }
        }
        return result;
    }

    /**
     * Backwards compatibility support for Trac 1.0 -> 1.2.  Trac v1.2 itself seems to construct
     * queries using the traditional 'changetime' but then reports the results using 'Modified'.
     * (It feels a bit sloppy to implement this here, but at least it seems to fix it centrally.)
     */
    private String tryAliases(String fieldName) {
        for (String alias : getAliases(fieldName)) {
            String result = m_Fields.get(alias);
            if (result != null) {
                return result;
            }
        }
        return null;
    }

    private Collection<String> getAliases(String fieldName) {
        if ("changetime".equals(fieldName)) {
            return Collections.singleton("Modified");
        }
        if ("Modified".equals(fieldName)) {
            return Collections.singleton("changetime");
        }
        return Collections.emptySet();
    }
}