Class CatalogEntry
Instances of this class represent individual entries in a Catalog.
Each catalog entry has a unique name and is associated with an arbitrary number of arguments (all strings). For example, the TR9401 catalog entry "PUBLIC" has two arguments, a public identifier and a system identifier. Each entry has a unique numeric type, assigned automatically when the entry type is created.
The number and type of catalog entries is maintained statically. Catalog classes, or their subclasses, can add new entry types, but all Catalog objects share the same global pool of types.
Initially there are no valid entries.
- Version:
- 1.0
- Author:
- Norman Walsh Norman.Walsh@Sun.COM
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Vector
The arguments associated with this entryprotected static Vector
The entryTypes vector maps catalog entry types to the number of arguments they're required to have.protected int
The entry type of this entryprotected static Hashtable
The entryTypes vector maps catalog entry names (e.g., 'BASE' or 'SYSTEM') to their type (1, 2, etc.).protected static int
The nextEntry is the ordinal number of the next entry type. -
Constructor Summary
ConstructorsConstructorDescriptionNull constructor; something for subclasses to call.CatalogEntry
(int type, Vector args) Construct a catalog entry of the specified type.CatalogEntry
(String name, Vector args) Construct a catalog entry of the specified type. -
Method Summary
Modifier and TypeMethodDescriptionstatic int
addEntryType
(String name, int numArgs) Adds a new catalog entry type.getEntryArg
(int argNum) Get an entry argument.static int
getEntryArgCount
(int type) Find out how many arguments an entry is required to have.static int
getEntryArgCount
(String name) Find out how many arguments an entry is required to have.int
Get the entry type.static int
getEntryType
(String name) Lookup an entry typevoid
setEntryArg
(int argNum, String newspec) Set an entry argument.
-
Field Details
-
nextEntry
protected static int nextEntryThe nextEntry is the ordinal number of the next entry type. -
entryTypes
The entryTypes vector maps catalog entry names (e.g., 'BASE' or 'SYSTEM') to their type (1, 2, etc.). Names are case sensitive. -
entryArgs
The entryTypes vector maps catalog entry types to the number of arguments they're required to have. -
entryType
protected int entryTypeThe entry type of this entry -
args
The arguments associated with this entry
-
-
Constructor Details
-
CatalogEntry
public CatalogEntry()Null constructor; something for subclasses to call. -
CatalogEntry
Construct a catalog entry of the specified type.- Parameters:
name
- The name of the entry typeargs
- A String Vector of arguments
-
CatalogEntry
Construct a catalog entry of the specified type.- Parameters:
type
- The entry typeargs
- A String Vector of arguments
-
-
Method Details
-
addEntryType
Adds a new catalog entry type.- Parameters:
name
- The name of the catalog entry type. This must be unique among all types and is case-sensitive. (Adding a duplicate name effectively replaces the old type with the new type.)numArgs
- The number of arguments that this entry type is required to have. There is no provision for variable numbers of arguments.- Returns:
- The type for the new entry.
-
getEntryType
Lookup an entry type- Parameters:
name
- The name of the catalog entry type.- Returns:
- The type of the catalog entry with the specified name.
-
getEntryArgCount
Find out how many arguments an entry is required to have.- Parameters:
name
- The name of the catalog entry type.- Returns:
- The number of arguments that entry type is required to have.
-
getEntryArgCount
Find out how many arguments an entry is required to have.- Parameters:
type
- A valid catalog entry type.- Returns:
- The number of arguments that entry type is required to have.
-
getEntryType
public int getEntryType()Get the entry type.- Returns:
- The entry type of the CatalogEntry
-
getEntryArg
Get an entry argument.- Parameters:
argNum
- The argument number (arguments are numbered from 0).- Returns:
- The specified argument or null if an invalid argNum is provided.
-
setEntryArg
Set an entry argument.Catalogs sometimes need to adjust the catlog entry parameters, for example to make a relative URI absolute with respect to the current base URI. But in general, this function should only be called shortly after object creation to do some sort of cleanup. Catalog entries should not mutate over time.
- Parameters:
argNum
- The argument number (arguments are numbered from 0).- Throws:
ArrayIndexOutOfBoundsException
- if an invalid argument number is provided.
-