Package gov.nih.mipav.model.file
Class XMLPSet
java.lang.Object
gov.nih.mipav.model.file.XMLPSet
- All Implemented Interfaces:
Serializable
Title: PSet
Description: Public class to store up to an infinite number of parameters... which will be in a Hashtable with name as the key Note: there must be at least one parameter associated with each parameter set per XSD (XML Schema)
Copyright: Copyright (c) 2004
Company:
- Version:
- 1.0
- Author:
- not attributable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringCurrent parameter name.private StringDescription of parameter.private Hashtable<String, XMLParameter> Parameter hashtable.private static final longUse serialVersionUID for interoperability. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddParameter(String name) Adds a new parameter to the set.booleancontainsKey(String key) Determines if the set contains a parameter with the given name.Returns the current parameter to be modified.Get the parameter set description.getParameter(String name) Gets the parameter with the given name.Get an enumeration for the list of parameter names.getTable()Gets the hashtable of parameters.voidremoveParameter(String name) Removes the parameter with the given name from the hashtable.voidsetDescription(String desc) toString()Returns a String representation of the Set.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDUse serialVersionUID for interoperability.- See Also:
-
currentParameterName
Current parameter name. -
description
Description of parameter. -
parameterTable
Parameter hashtable.
-
-
Constructor Details
-
XMLPSet
Create a new parameter set with the given description.- Parameters:
description- String description of parameter set
-
-
Method Details
-
addParameter
Adds a new parameter to the set.- Parameters:
name- String name
-
containsKey
Determines if the set contains a parameter with the given name.- Parameters:
key- String parameter name (key)- Returns:
- boolean set contains parameter
-
getCurrentParameter
Returns the current parameter to be modified.- Returns:
- Parameter current parameter
-
getDescription
Get the parameter set description.- Returns:
- String description
-
setDescription
-
getParameter
Gets the parameter with the given name.- Parameters:
name- DOCUMENT ME!- Returns:
- Parameter parameter
-
getParameterKeys
Get an enumeration for the list of parameter names.- Returns:
- Enumeration enumeration for parameter name list
-
getTable
Gets the hashtable of parameters.- Returns:
- Hashtable parameter hashtable
-
removeParameter
Removes the parameter with the given name from the hashtable.- Parameters:
name- String parameter name
-
toString
Returns a String representation of the Set.
-