All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class w3c.pics.db.Category

java.lang.Object
   |
   +----w3c.pics.db.Category

public class Category
extends Object
Categories are the building blocks of Services. Category recursively parses the necessary information from the service description (.rat) file.

See Also:
Service

Constructor Index

 o Category()
Creates a new, empty Category.
 o Category(PICSTokenizer, Category)
Constructs a Category from a PICSTokenizer.

Method Index

 o getCategoryData()
Returns the CategoryData object associated with this Category.
 o getCategorylist()
Returns the categorylist contained within this Category.
 o getDescription()
Return the description for this Category.
 o getEnumlist()
Returns the list of Enums for this Category.
 o getIcon()
Return the icon for this Category.
 o getMax()
Return the maximum value for this Category.
 o getMin()
Return the minimum value for this Category.
 o getName()
Return the name of this Category.
 o getTransmitas()
Return the transmit name of this Category.
 o isInteger()
Returns the value of the integer flag.
 o isLabelonly()
Returns the value of the labelonly flag.
 o isMultivalue()
Used to see if this Category is multivalued.
 o isUnordered()
Used to see if this Category is unordered.
 o putRange(Filter)
Takes the values in this Category and puts them into the Filter FL.
 o toString()
Returns a human-readable description of this Category.

Constructors

 o Category
 public Category()
Creates a new, empty Category.

 o Category
 public Category(PICSTokenizer PT,
                 Category cat) throws PICSException, IOException
Constructs a Category from a PICSTokenizer.

Parameters:
PT - The PICSTokenizer.
cat - The parent category with attibutes to be inherited.
Throws: PICSException
If parsing of the service description failed.
Throws: IOException
If reading the service description file failed.

Methods

 o toString
 public String toString()
Returns a human-readable description of this Category. Note that the description is not according the syntax of application/pics-service.

Returns:
A String representing the Category.
Overrides:
toString in class Object
 o getIcon
 public String getIcon()
Return the icon for this Category.

Returns:
A String representing the icon for this Category.
 o getDescription
 public String getDescription()
Return the description for this Category.

Returns:
A String description of this Category.
 o getTransmitas
 public String getTransmitas()
Return the transmit name of this Category.

Returns:
A String, the transmit name of this Category.
 o getName
 public String getName()
Return the name of this Category.

Returns:
A String, the human-readable name of this Category.
 o getCategorylist
 public Vector getCategorylist()
Returns the categorylist contained within this Category. The categorylist is the list of this Category's children.

Returns:
A Vector, containing this Category's children.
 o getMax
 public double getMax()
Return the maximum value for this Category.

Returns:
A double, the maximum value allowed for this Category.
 o getMin
 public double getMin()
Return the minimum value for this Category.

Returns:
A double, the minimum value allowed for this Category.
 o isMultivalue
 public boolean isMultivalue()
Used to see if this Category is multivalued.

Returns:
A boolean, true if this Category is multivalued, false otherwise.
 o isUnordered
 public boolean isUnordered()
Used to see if this Category is unordered.

Returns:
A boolean, true if this Category is unordered, false otherwise.
 o isLabelonly
 public boolean isLabelonly()
Returns the value of the labelonly flag.

Returns:
A boolean with the value of the labelonly flag.
 o isInteger
 public boolean isInteger()
Returns the value of the integer flag.

Returns:
A boolean with the value of the integer flag.
 o getEnumlist
 public Vector getEnumlist()
Returns the list of Enums for this Category. Each Enum stores information about a particular value for a Category.

Returns:
A Vector containing the Enums.
See Also:
Enum
 o getCategoryData
 protected CategoryData getCategoryData()
Returns the CategoryData object associated with this Category.

Returns:
A CategoryData object.
 o putRange
 public void putRange(Filter FL)
Takes the values in this Category and puts them into the Filter FL.

Parameters:
FL - The Filter in which to put this Category's values.

All Packages  Class Hierarchy  This Package  Previous  Next  Index