fedora.server.resourceIndex
Class ParamDomainMap

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.TreeMap<java.lang.String,ParamDomain>
          fedora.server.resourceIndex.ParamDomainMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,ParamDomain>, java.util.SortedMap<java.lang.String,ParamDomain>

public class ParamDomainMap
extends java.util.TreeMap<java.lang.String,ParamDomain>

A sorted map of all ParamDomains for a method, keyed by parameter name. As per the SortedMap contract, iterators over the parameter names in this collection will provide the keys in ascending order.

Author:

cwilper@cs.cornell.edu

See Also:

Serialized Form

Constructor Summary

ParamDomainMap(java.lang.String methodName)
Get an empty instance.

ParamDomainMap(java.lang.String methodName, MethodParmDef[] parmDefs, boolean userInputOnly)
Get an instance from an existing array of MethodParmDefs.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getMethodName() Get the name of the method this map describes.
java.util.Set<java.lang.String>	getPermutations() Get all permutations of the method.

Methods inherited from class java.util.TreeMap

clear, clone, comparator, containsKey, containsValue, entrySet, firstKey, get, headMap, keySet, lastKey, put, putAll, remove, size, subMap, tailMap, values

Methods inherited from class java.util.AbstractMap

hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

hashCode, isEmpty

Constructor Detail

ParamDomainMap

public ParamDomainMap(java.lang.String methodName)

Get an empty instance.

Parameters:

methodName - the name of the method this map describes.

ParamDomainMap

public ParamDomainMap(java.lang.String methodName,
                      MethodParmDef[] parmDefs,
                      boolean userInputOnly)

Get an instance from an existing array of MethodParmDefs.

Parameters:

methodName - the name of the method this map describes.

parmDefs - existing parameter definitions.

userInputOnly - if true, only USER_INPUT parameters from the given array will be used.

Method Detail

getMethodName

public java.lang.String getMethodName()

Get the name of the method this map describes.

Returns:

the name of the method this map describes.

getPermutations

public java.util.Set<java.lang.String> getPermutations()

Get all permutations of the method. A "permutation" is a known runtime method invocation, and is formatted as in the following examples:

• methodName
• methodName?parm1=val1&parm2=val1
• methodName?parm1=val1&parm2=val2
• methodName?parm1=val2&parm2=val1
• methodName?parm1=val2&parm2=val2

Returns:

the set of invokable permutations for the method.

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<java.lang.String,ParamDomain>

Overrides:

equals in class java.util.AbstractMap<java.lang.String,ParamDomain>