com.github.errantlinguist.latticevisualiser.EdgeStrokeTransformer.java Source code

Introduction

Here is the source code for com.github.errantlinguist.latticevisualiser.EdgeStrokeTransformer.java

Source

/*
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
    
 http://www.apache.org/licenses/LICENSE-2.0
    
 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 */

package com.github.errantlinguist.latticevisualiser;

import java.awt.BasicStroke;
import java.awt.Stroke;

import org.apache.commons.collections15.Transformer;

import com.google.common.collect.ImmutableSet;

/**
 * A {@link Transformer} for deriving the {@link Stroke} to use for drawing an
 * edge from the respective {@link Edge} characteristics it represents.
 * 
 * @author Todd Shore
 * @version 2011-11-12
 * @since 2011-11-12
 * 
 */
public class EdgeStrokeTransformer implements Settings, Transformer<Edge, Stroke> {

    /**
     * The pre-cached hash code.
     */
    private final int hashCode;

    /**
     * The {@link ImmutableSet} of symbols which represent non-word labels.
     */
    private final ImmutableSet<String> nonwords;

    /**
     * 
     * @param nonwords
     *            An {@link ImmutableSet} of symbols which represent non-word
     *            labels.
     */
    public EdgeStrokeTransformer(final ImmutableSet<String> nonwords) {
        this.nonwords = nonwords;

        hashCode = calculateHashCode();
    }

    /**
     * 
     * @return The hash code.
     */
    private int calculateHashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + (nonwords == null ? 0 : nonwords.hashCode());
        return result;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof EdgeStrokeTransformer)) {
            return false;
        }
        final EdgeStrokeTransformer other = (EdgeStrokeTransformer) obj;
        if (nonwords == null) {
            if (other.nonwords != null) {
                return false;
            }
        } else if (!nonwords.equals(other.nonwords)) {
            return false;
        }
        return true;
    }

    /**
     * @return The {@link ImmutableSet} of symbols which represent non-word
     *         labels.
     */
    public ImmutableSet<String> getNonwords() {
        return nonwords;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return hashCode;
    }

    /*
     * (non-Javadoc)
     * 
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        final StringBuilder builder = new StringBuilder();
        final String className = this.getClass().getSimpleName();
        builder.append(className);
        builder.append("[nonwords=");
        builder.append(nonwords);
        builder.append("]");
        return builder.toString();
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.apache.commons.collections15.Transformer#transform(java.lang.Object)
     */
    @Override
    public Stroke transform(final Edge edge) {
        // Edges are negative log probabilities
        final double probability = Math.pow(10, -edge.getWeight());
        final float weight = (float) probability * WEIGHT_FACTOR;
        // System.out.println(Float.toString(weight));
        Stroke stroke;
        if (nonwords != null && nonwords.contains(edge.getOutputSymbol())) {
            stroke = new BasicStroke(weight, BasicStroke.CAP_BUTT, BasicStroke.JOIN_MITER, 10.0f, STROKE_DASH,
                    0.0f);
        } else {
            stroke = new BasicStroke(weight);
        }

        return stroke;
    }

}