stringmapattribute.java

一个工作流设计及定义的系统,可以直接与数据库结合进行系统工作流程的定义及应用.

/*
 * Copyright (c) 2005, John Mettraux, OpenWFE.org
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * . Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.  
 * 
 * . Redistributions in binary form must reproduce the above copyright notice, 
 *   this list of conditions and the following disclaimer in the documentation 
 *   and/or other materials provided with the distribution.
 * 
 * . Neither the name of the "OpenWFE" nor the names of its contributors may be
 *   used to endorse or promote products derived from this software without
 *   specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * $Id: StringMapAttribute.java,v 1.9 2005/07/27 15:59:02 jmettraux Exp $
 */

//
// StringMapAttribute.java
//
// [e-mail]
//
// generated with 
// jtmpl 1.0.04 31.10.2002 John Mettraux ([e-mail])
//

package openwfe.org.engine.workitem;

/**
 * A dictionary of attributes whose key must be StringAttribute instances.
 * Important thing : each InFlowWorkitem has as root attribute an instance of
 * StringMapAttribute.<br>
 * This class extends MapAttribute. It introduces a lot of shortcut methods for
 * working with strings.<br>
 * You should also see 'AttributeUtils' in the same package to find method
 * helping you to work with attributes.
 *
 * <p><font size=2>CVS Info :
 * <br>$Author: jmettraux $
 * <br>$Date: 2005/07/27 15:59:02 $
 * <br>$Id: StringMapAttribute.java,v 1.9 2005/07/27 15:59:02 jmettraux Exp $ </font>
 *
 * @author [e-mail]
 */
public class StringMapAttribute

    extends MapAttribute

{

    //
    // FIELDS

    //
    // CONSTRUCTORS

    /**
     * Builds an empty map 
     */
    public StringMapAttribute () 
    {
        super();
    }

    /**
     * Builds an empty map with a given initial capacity (if you know
     * the capacity in advance, use this constructor, it may save you
     * the performance hit induced by the map growing to a bigger capacity).
     */
    public StringMapAttribute (int initialCapacity) 
    {
        super(initialCapacity);
    }

    //
    // METHODS

    /**
     * Returns the attribute corresponding to the given String key.
     */
    public Attribute get (final String key)
    {
        return (Attribute)getMap().get(new StringAttribute(key));
    }

    /**
     * Like get() but returns the attribute value as a String.
     */
    public String sget (final String key)
    {
        final Attribute a = get(key);
        if (a == null) return null;
        return a.toString();
    }

    /**
     * Puts in the map a new entry. A previous entry with the same key name
     * will get overriden.
     */
    public void put (String key, Attribute value)
    {
        getMap().put(new StringAttribute(key), value);
    }

    /**
     * Puts an entry composed of two strings (a StringAttribute will also
     * be created for the value).
     */
    public void puts (final String key, final String value)
    {
        getMap().put(new StringAttribute(key), new StringAttribute(value));
    }

    /**
     * Removes a given entry.
     */
    public void remove (final String key)
    {
        getMap().remove(new StringAttribute(key));
    }

    /**
     * Returns true if this StringMapAttribute instance contains the
     * given key.
     */
    public boolean hasKey (final String key)
    {
        return (this.get(key) != null);
    }

    /**
     * Returns the set of key names (String instances) of this map that
     * match the given regex.
     */
    public java.util.Set keyNamesMatching (final String regex)
    {
        final java.util.Set result = new java.util.HashSet();

        final java.util.Iterator it = this.keySet().iterator();
        while (it.hasNext())
        {
            final String key = it.next().toString();
            if (key.matches(regex)) result.add(key);
        }

        return result;
    }

    /**
     * This returns a set of String keys (not StringAttribute keys)
     */
    public java.util.Set stringKeySet ()
    {
        java.util.Set initialSet = super.keySet();

        java.util.Set set = new java.util.HashSet();

        java.util.Iterator it = initialSet.iterator();
        while (it.hasNext())
        {
            set.add(it.next().toString());
        }

        return set;
    }

    /**
     * The classical clone method.
     */
    public Object clone ()
    {
        StringMapAttribute clone = new StringMapAttribute(this.size());

        java.util.Iterator it = getMap().keySet().iterator();
        while (it.hasNext())
        {
            Attribute key = (Attribute)it.next();
            Attribute value = this.get(key);

            clone.put((Attribute)key.clone(), (Attribute)value.clone());
        }

        return clone;
    }

    /**
     * Returns an alphabetically sorted iterator on the keys of this
     * StringMapAttribute.
     * The keys returned are String instances, not StringAttribute ones.
     * It's then easy to get the value attributes with
     * <pre>
     * Attribute a = smap.get(key);
     * </pre>
     */
    public java.util.Iterator alphaStringIterator ()
    {
        final java.util.List keyList = 
            new java.util.LinkedList(this.stringKeySet());

        java.util.Collections.sort(keyList);

        return keyList.iterator();
    }

    /**
     * This is a particular iterator : it iterates on the value of a field 
     * given by its name.
     * For instance, if in this StringMapAttribute you have a field named
     * 'toto' that points to a StringAttribute containing "foo, bar",
     * this method will return an iterator on [ "foo", "bar" ].<br>
     * Similarly, if 'toto' would point to a ListAttribute containing
     * [ new StringAttribute("foo2"), new StringAttribute("bar2") ], it
     * would return an iterator on [ "foo2", "bar2" ].<br>
     * If the fieldName points to nothing, null is returned.
     */
    public java.util.Iterator fieldIterator (final String fieldName)
    {
        final Attribute a = this.get(fieldName);

        if (a == null) return null;

        if (a instanceof ListAttribute)
        {
            final java.util.List l = AttributeUtils.list2java((ListAttribute)a);

            return l.iterator();
        }

        final String[] ss = a.toString().trim().split(", *");

        return java.util.Arrays.asList(ss).iterator();
    }

}