| Interface | Description | 
|---|---|
| AuthInterface | 
 An interface representing the methods that should be
 implemented by an authentication service. 
 | 
| Class | Description | 
|---|---|
| AccessionNumber | 
 (on insert of XML document)
 Generates a unique Accession Number or if provided check it
 for uniqueness and register it into the db connection
 (on update or delete of XML document)
 Check for existance of provided Accession Number 
 | 
| ArchiveHandler | |
| AssociateAccessPolicy | 
 This class is in order to fix a problem. 
 | 
| AuthLdap | 
 An implementation of the AuthInterface interface that allows Metacat to use
 the LDAP protocol for directory services. 
 | 
| AuthSession | 
 A Class that implements session tracking for MetaCatServlet users. 
 | 
| AuthStub | 
 An implementation of the AuthInterface interface that
 allows Metacat to use the LDAP protocol for directory services. 
 | 
| AuthTest | 
 An implementation of the AuthInterface interface that
 allows Metacat to use the LDAP protocol for directory services. 
 | 
| BasicNode | 
 A Class that represents an XML node and its contents 
 | 
| CatalogMessageHandler | 
 A Class implementing callback bethods for the SAX parser to
 call when processing the XML messages from the replication handler 
 | 
| CommentNode | 
 A Class that represents an XML Comment node and its contents, 
 | 
| ContentTypeProvider | 
 This class will figure out which content type it is for a given data file. 
 | 
| DBDTDHandler | 
 A database aware Class implementing DTDHandler interface for the SAX 
 parser to call when processing the XML stream and intercepting notations 
 and unparsed entities 
 | 
| DBEntityResolver | 
 A database aware Class implementing EntityResolver interface for the SAX
 parser to call when processing the XML stream and intercepting any
 external entities (including the external DTD subset and external
 parameter entities, if any) before including them. 
 | 
| DBQuery | 
 A Class that searches a relational DB for elements and attributes that have
 free text matches a query string, or structured query matches to a path
 specified node in the XML hierarchy. 
 | 
| DBSAXHandler | 
 A database aware Class implementing callback bethods for the SAX parser to
 call when processing the XML stream and generating events. 
 | 
| DBSAXNode | 
 A Class that represents an XML node and its contents and
 can write its own representation to a database connection 
 | 
| DBSimpleQuery | 
 A Class that searches a relational DB for elements and attributes that
 have free text matches to the query string. 
 | 
| DBTransform | 
 A Class that transforms XML documents utitlizing XSL style sheets
 Building a transformer from the .xsl is expensive, so Templates are used                                            
 as an intermediate construct to allow lightweight construction of Transformers. 
 | 
| DBUtil | 
 A suite of utility classes for querying DB 
 | 
| DBValidate | 
 Name: DBValidate.java
       Purpose: A Class that validates XML documents
                           This class is designed to be parser independent
                           i.e. 
 | 
| DistributionSection | 
 A Class that represents an XML access rule. 
 | 
| DocumentIdentifier | 
 A class to parse document ids
 The docid is of the form siteCode.uniqueId.rev 
 | 
| DocumentIdQuery | 
 Generate a pathquery document representing a metacat query for a list of
 document IDs. 
 | 
| DocumentImpl | 
 A class that represents an XML document. 
 | 
| DocumentImplWrapper | 
 This class a wrapper class for documentimpl for insert or update. 
 | 
| ElementNode | 
 A Class that represents an XML element and its contents,
 and can build itself from a database connection 
 | 
| Eml200SAXHandler | 
 A database aware Class implementing callback methods for the SAX parser to
 call when processing the XML stream and generating events
 Here is the rules for user which has write permission in top level access
 rules(he can update metadata but can't update access module) try to update
 a document:
 1. 
 | 
| EML201DocumentCorrector | 
 Before Metacat 1.8.1 release, Metacat uses the eml201 schema with the tag
 RELEASE_EML_2_0_1_UPDATE_5. 
 | 
| Eml210SAXHandler | 
 A database aware Class implementing callback methods for the SAX parser to
 call when processing the XML stream and generating events 
 | 
| EventLog | 
 EventLog is used to intialize and store a log of events that occur in an
 application. 
 | 
| EventLogData | 
 A data structure holding the information to be logged about an event. 
 | 
| EventLogFilter | 
 This class represents a filter to prevent the events generated by some ip addresses and subjects
 to be logged into db 
 | 
| IdentifierManager | 
 Manage the relationship between Metacat local identifiers (LocalIDs) that are
 codified as the (docid, rev) pair with globally unique string identifiers
 (GUIDs) that are opaque strings. 
 | 
| IndexingQueue | |
| IndexingTimerTask | |
| MetacatHandler | 
 General entry point for the Metacat server which is called from various 
 mechanisms such as the standard MetacatServlet class and the various web
 service servlets such as RestServlet class. 
 | 
| MetacatProfiler | |
| MetacatResultSet | |
| MetaCatServlet | 
 A metadata catalog server implemented as a Java Servlet
 Valid actions are:
 
 action=login
     username
     password
     qformat
 action=logout
     qformat
 action=query -- query the values of all elements and attributes and return a result set of nodes
     meta_file_id --
     returndoctype --
     filterdoctype --
     returnfield --
     owner --
     site --
     operator --
     casesensitive --
     searchmode --
     anyfield --
 action=spatial_query -- run a spatial query. 
 | 
| MetacatURL | |
| MetacatVersion | |
| NodeComparator | 
 A utility class that sorts two node records. 
 | 
| NodeRecord | 
 A utility class that encapsulates a node and its data 
 | 
| PathIndexEntry | 
 PathIndexEntry contains all of the data fields needed to insert an path into
 the xml_index table or the xml_path_index table, depending on which 
 constructor is used. 
 | 
| PermissionController | |
| PINode | 
 A Class that represents an XML PI node and its contents, 
 | 
| QueryGroup | 
 a utility class that represents a group of terms in a query 
 | 
| QueryResultTableBuilder | 
 QueryResutlTableBuilder is class to build xml_queryresult table during metacat initialization. 
 | 
| QuerySpecification | 
 A Class that represents a structured query, and can be constructed from an
 XML serialization conforming to 
 | 
| QueryTerm | 
 a utility class that represents a single term in a query 
 | 
| ReadOnlyChecker | 
 A checker to determine if the Metacat is in the read-only mode by checking
 the property of database.readOnly. 
 | 
| RelationHandler | |
| RemoteDocument | 
 A class represents a document in remote metacat server. 
 | 
| SchemaLocationResolver | 
 A database aware Class to handle schema location. 
 | 
| Sitemap | 
 A Sitemap represents a document that lists all of the content of the Metacat
 server for use by harvesting spiders that wish to index the contents of the
 Metacat site. 
 | 
| SubTree | 
 A Class that represents an XML Subtree 
 | 
| TextNode | 
 A Class that represents an XML Text node and its contents, 
 | 
| Version | |
| XMLQueryresultAccess | 
| Exception | Description | 
|---|---|
| AccessionNumberException | 
 Exception thrown when an error occurs because an AccessionNumber was 
 invalid or used incorrectly. 
 | 
| AuthTLSException | 
 Exception thrown when an error occurs in a configuration administrative
 class 
 | 
| ErrorHandledException | 
 Exception thrown when an error occurs in a configuration administrative
 class 
 | 
| McdbDocNotFoundException | 
 Exception thrown when an error occurs because a document with a
 given ID could not be found in the metacat database. 
 | 
| McdbException | 
 Exception thrown when an error occurs because a problem occurred in
 the metacat database. 
 | 
Copyright © 2020 Regents of the University of California. All Rights Reserved.