org.apache.xml.resolver
Class CatalogEntry
public class CatalogEntry
Represents a Catalog entry.
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.
protected Vector | args - The arguments associated with this entry
|
protected static Vector | entryArgs - The entryTypes vector maps catalog entry types to the
number of arguments they're required to have.
|
protected int | entryType - The entry type of this entry
|
protected static Hashtable | entryTypes - The entryTypes vector maps catalog entry names
(e.g., 'BASE' or 'SYSTEM') to their type (1, 2, etc.).
|
protected static int | nextEntry - The nextEntry is the ordinal number of the next entry type.
|
CatalogEntry() - Null constructor; something for subclasses to call.
|
CatalogEntry(String name, Vector args) - Construct a catalog entry of the specified type.
|
CatalogEntry(int type, Vector args) - Construct a catalog entry of the specified type.
|
static int | addEntryType(String name, int numArgs) - Adds a new catalog entry type.
|
String | getEntryArg(int argNum) - Get an entry argument.
|
static int | getEntryArgCount(String name) - Find out how many arguments an entry is required to have.
|
static int | getEntryArgCount(int type) - Find out how many arguments an entry is required to have.
|
int | getEntryType() - Get the entry type.
|
static int | getEntryType(String name) - Lookup an entry type
|
void | setEntryArg(int argNum, String newspec) - Set an entry argument.
|
args
protected Vector args
The arguments associated with this entry
entryArgs
protected static Vector entryArgs
The entryTypes vector maps catalog entry types to the
number of arguments they're required to have.
entryType
protected int entryType
The entry type of this entry
entryTypes
protected static Hashtable entryTypes
The entryTypes vector maps catalog entry names
(e.g., 'BASE' or 'SYSTEM') to their type (1, 2, etc.).
Names are case sensitive.
nextEntry
protected static int nextEntry
The nextEntry is the ordinal number of the next entry type.
CatalogEntry
public CatalogEntry()
Null constructor; something for subclasses to call.
CatalogEntry
public CatalogEntry(String name,
Vector args)
throws CatalogException
Construct a catalog entry of the specified type.
name
- The name of the entry typeargs
- A String Vector of arguments
CatalogEntry
public CatalogEntry(int type,
Vector args)
throws CatalogException
Construct a catalog entry of the specified type.
type
- The entry typeargs
- A String Vector of arguments
addEntryType
public static int addEntryType(String name,
int numArgs)
Adds a new catalog entry type.
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.
- The type for the new entry.
getEntryArg
public String getEntryArg(int argNum)
Get an entry argument.
argNum
- The argument number (arguments are numbered from 0).
- The specified argument or null if an invalid argNum is
provided.
getEntryArgCount
public static int getEntryArgCount(String name)
throws CatalogException
Find out how many arguments an entry is required to have.
name
- The name of the catalog entry type.
- The number of arguments that entry type is required to have.
getEntryArgCount
public static int getEntryArgCount(int type)
throws CatalogException
Find out how many arguments an entry is required to have.
type
- A valid catalog entry type.
- The number of arguments that entry type is required to have.
getEntryType
public int getEntryType()
Get the entry type.
- The entry type of the CatalogEntry
getEntryType
public static int getEntryType(String name)
throws CatalogException
Lookup an entry type
name
- The name of the catalog entry type.
- The type of the catalog entry with the specified name.
setEntryArg
public void setEntryArg(int argNum,
String newspec)
throws ArrayIndexOutOfBoundsException
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.
argNum
- The argument number (arguments are numbered from 0).
Copyright B) 2001-2003 Apache Software Foundation. All Rights Reserved.