|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xml.resolver.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.
Catalog
Constructor Summary | |
---|---|
CatalogEntry()
Null constructor; something for subclasses to call. |
|
CatalogEntry(int type,
java.util.Vector args)
Construct a catalog entry of the specified type. |
|
CatalogEntry(java.lang.String name,
java.util.Vector args)
Construct a catalog entry of the specified type. |
Method Summary | |
---|---|
static int |
addEntryType(java.lang.String name,
int numArgs)
Adds a new catalog entry type. |
java.lang.String |
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(java.lang.String name)
Find out how many arguments an entry is required to have. |
int |
getEntryType()
Get the entry type. |
static int |
getEntryType(java.lang.String name)
Lookup an entry type |
void |
setEntryArg(int argNum,
java.lang.String newspec)
Set an entry argument. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CatalogEntry()
public CatalogEntry(java.lang.String name, java.util.Vector args) throws CatalogException
name
- The name of the entry typeargs
- A String Vector of arguments
InvalidCatalogEntryTypeException
- if no such entry type
exists.
InvalidCatalogEntryException
- if the wrong number of arguments
is passed.
CatalogException
public CatalogEntry(int type, java.util.Vector args) throws CatalogException
type
- The entry typeargs
- A String Vector of arguments
InvalidCatalogEntryTypeException
- if no such entry type
exists.
InvalidCatalogEntryException
- if the wrong number of arguments
is passed.
CatalogException
Method Detail |
---|
public static int addEntryType(java.lang.String name, int numArgs)
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.
public static int getEntryType(java.lang.String name) throws CatalogException
name
- The name of the catalog entry type.
InvalidCatalogEntryTypeException
- if no entry has the
specified name.
CatalogException
public static int getEntryArgCount(java.lang.String name) throws CatalogException
name
- The name of the catalog entry type.
InvalidCatalogEntryTypeException
- if no entry has the
specified name.
CatalogException
public static int getEntryArgCount(int type) throws CatalogException
type
- A valid catalog entry type.
InvalidCatalogEntryTypeException
- if the type is invalid.
CatalogException
public int getEntryType()
public java.lang.String getEntryArg(int argNum)
argNum
- The argument number (arguments are numbered from 0).
public void setEntryArg(int argNum, java.lang.String newspec) throws java.lang.ArrayIndexOutOfBoundsException
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).
java.lang.ArrayIndexOutOfBoundsException
- if an invalid argument
number is provided.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |