|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.avalon.excalibur.catalog.CatalogEntry
Represents an OASIS Open Catalog entry.
Instances of this class represent individual entries from an OASIS Open Catalog file.While this could have been implemented as a base class with a separate subclass for each type of catalog entry, it didn't seem to be worth the extra overhead.
Catalog
Field Summary | |
static int |
BASE
The entry type for a BASE entry |
static int |
CATALOG
The entry type for a CATALOG entry |
static int |
DELEGATE
The entry type for a DELEGATE entry |
static int |
DOCTYPE
The entry type for a DOCTYPE entry |
static int |
DOCUMENT
The entry type for a DOCUMENT entry |
static int |
DTDDECL
The entry type for a DTDDECL entry |
static int |
ENTITY
The entry type for a ENTITY entry |
static int |
LINKTYPE
The entry type for a LINKTYPE entry |
static int |
NOTATION
The entry type for a NOTATION entry |
static int |
OVERRIDE
The entry type for a OVERRIDE entry |
static int |
PUBLIC
The entry type for a PUBLIC entry |
static int |
SGMLDECL
The entry type for a SGMLDECL entry |
static int |
SYSTEM
The entry type for a SYSTEM entry |
Constructor Summary | |
CatalogEntry(int type,
java.lang.String spec)
Construct a catalog entry of the specified type. |
|
CatalogEntry(int type,
java.lang.String spec,
java.lang.String fsispec)
Construct a catalog entry of the specified type. |
Method Summary | |
java.lang.String |
entityName()
The entity name |
int |
entryType()
The entry type |
java.lang.String |
formalSystemIdentifier()
The formal system identifier of the entry, if appropriate |
java.lang.String |
partialPublicId()
The partial public identifier of a DELEGATE entry. |
java.lang.String |
publicId()
The public identifier |
java.lang.String |
systemId()
The system identifier |
void |
updateFormalSystemIdentifier(java.lang.String newspec)
Update the formal system identifier |
java.lang.String |
yes_or_no()
The argument, YES or NO, of an OVERRIDE entry. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int BASE
public static final int CATALOG
public static final int DOCUMENT
public static final int OVERRIDE
public static final int SGMLDECL
public static final int DELEGATE
public static final int DOCTYPE
public static final int DTDDECL
public static final int ENTITY
public static final int LINKTYPE
public static final int NOTATION
public static final int PUBLIC
public static final int SYSTEM
Constructor Detail |
public CatalogEntry(int type, java.lang.String spec) throws InvalidCatalogEntryTypeException, InvalidCatalogEntryException
Construct a catalog entry of the specified type. The two-argument form of the constructor can be used for BASE, CATALOG, DOCUMENT, OVERRIDE, and SGMLDECL entries.
type
- The entry type.spec
- The argument to the entry, a formal system identifier in all
cases except OVERRIDE when it must be either "yes" or "no".InvalidCatalogEntryTypeException
- DOC: Insert Description of
ExceptionInvalidCatalogEntryException
- DOC: Insert Description of
Exceptionpublic CatalogEntry(int type, java.lang.String spec, java.lang.String fsispec) throws InvalidCatalogEntryTypeException, InvalidCatalogEntryException
Construct a catalog entry of the specified type. The three-argument form of the constructor can be used for DELEGATE, DOCTYPE, DTDDECL, ENTITY, LINKTYPE, NOTATION, PUBLIC, and SYSTEM entries.
type
- The entry type.spec
- DOC: Insert Description of Parameterfsispec
- DOC: Insert Description of ParameterInvalidCatalogEntryTypeException
- DOC: Insert Description of
ExceptionInvalidCatalogEntryException
- DOC: Insert Description of
ExceptionMethod Detail |
public int entryType()
The entry type
public java.lang.String formalSystemIdentifier()
The formal system identifier of the entry, if appropriate
public java.lang.String yes_or_no()
The argument, YES or NO, of an OVERRIDE entry.
public java.lang.String partialPublicId()
The partial public identifier of a DELEGATE entry.
public java.lang.String entityName()
The entity name
public java.lang.String publicId()
The public identifier
public java.lang.String systemId()
The system identifier
public void updateFormalSystemIdentifier(java.lang.String newspec)
Update the formal system identifier
The FSI initial specified in an entry may be relative (to the location of
the catalog file or as modified by a BASE entry). A system processing
catalog files (e.g. com.arbortext.catalog.Catalog
), must be able
to update the FSI in order to change it from a relative location to an
absolute one.
newspec
- The new FSI
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |