|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.ucsb.nceas.metacat.DocumentImpl
A class that represents an XML document. It can be created with a simple document identifier from a database connection. It also will write an XML text document to a database connection using SAX.
Field Summary | |
static java.lang.String |
DECLARATIONHANDLERPROPERTY
|
static java.lang.String |
DOCNAME
|
static java.lang.String |
DTD
|
static java.lang.String |
EML2_0_0NAMESPACE
|
static java.lang.String |
EML2_0_1NAMESPACE
|
static java.lang.String |
EML2_1_0NAMESPACE
|
static java.lang.String |
EML200
|
static java.lang.String |
EML210
|
static java.lang.String |
EXTERNALSCHEMALOCATIONPROPERTY
|
static java.lang.String |
LEXICALPROPERTY
|
static java.lang.String |
NAMESPACEFEATURE
|
static java.lang.String |
NAMESPACEPREFIXESFEATURE
|
static java.lang.String |
PUBLICID
|
static java.lang.String |
SCHEMA
|
static java.lang.String |
SCHEMAVALIDATIONFEATURE
|
static java.lang.String |
SYSTEMID
|
static java.lang.String |
VALIDATIONFEATURE
|
Constructor Summary | |
DocumentImpl(DBConnection conn,
long rootNodeId,
java.lang.String docName,
java.lang.String docType,
java.lang.String docId,
java.lang.String newRevision,
java.lang.String action,
java.lang.String user,
java.lang.String pub,
java.lang.String catalogId,
int serverCode)
Construct a new document instance, writing the contents to the database. |
|
DocumentImpl(java.lang.String docid)
Constructor, creates document from database connection, used for reading the document |
|
DocumentImpl(java.lang.String docid,
boolean readNodes)
Constructor used to create a document and read the document information from the database. |
Method Summary | |
void |
buildIndex()
Build the index records for this document. |
static void |
delete(java.lang.String accnum,
java.lang.String user,
java.lang.String[] groups,
java.lang.String notifyServer)
Delete an XML file from the database (actually, just make it a revision in the xml_revisions table) |
java.lang.String |
getCreateDate()
get the creation date |
static boolean |
getDataFileLockGrant(java.lang.String accnum)
Get a lock for a given document. |
static boolean |
getDataFileLockGrant(java.lang.String accnum,
int serverCode)
The method will check if metacat can get data file lock grant If server code is 1, it get. |
java.lang.String |
getDocHomeServer()
|
java.lang.String |
getDocID()
Get the document identifier (docid) |
java.lang.String |
getDocname()
get the document name |
java.lang.String |
getDoctype()
get the document type (which is the PublicID) |
static int |
getLatestRevisionNumber(java.lang.String docId)
Get last revision number from database for a docid If couldn't find an entry, -1 will return The return value is integer because we want compare it to there new one |
java.lang.String |
getPublicaccess()
|
int |
getRev()
|
long |
getRootNodeID()
get the root node identifier |
int |
getServerlocation()
|
java.lang.String |
getSystemID()
get the system identifier |
java.lang.String |
getUpdateDate()
get the update date |
java.lang.String |
getUserowner()
|
java.lang.String |
getUserupdated()
|
java.lang.String |
getValidateType()
|
static boolean |
hasReadPermission(java.lang.String user,
java.lang.String[] groups,
java.lang.String docId)
Check for "READ" permission base on docid, user and group |
static void |
main(java.lang.String[] args)
the main routine used to test the DBWriter utility. |
java.lang.String |
readUsingSlowAlgorithm()
Get a text representation of the XML document as a string This older algorithm uses a recursive tree of Objects to represent the nodes of the tree. |
static void |
registerDocument(java.lang.String docname,
java.lang.String doctype,
java.lang.String accnum,
java.lang.String user,
java.lang.String[] groupnames)
This method will be call in handleUploadRequest in MetacatServlet class |
static void |
registerDocument(java.lang.String docname,
java.lang.String doctype,
java.lang.String accnum,
java.lang.String user,
java.lang.String[] groups,
int serverCode)
Register a document that resides on the filesystem with the database. |
static void |
registerDocumentInReplication(java.lang.String docname,
java.lang.String doctype,
java.lang.String accnum,
java.lang.String user,
int serverCode)
Register a document that resides on the filesystem with the database. |
java.lang.String |
toString()
Print a string representation of the XML document |
java.lang.String |
toString(java.lang.String user,
java.lang.String[] groups,
boolean withInlinedata)
Print a string representation of the XML document |
void |
toXml(java.io.Writer pw,
java.lang.String user,
java.lang.String[] groups,
boolean withInLineData)
Print a text representation of the XML document to a Writer |
static java.lang.String |
write(DBConnection conn,
java.io.Reader xml,
java.lang.String pub,
java.io.Reader dtd,
java.lang.String action,
java.lang.String accnum,
java.lang.String user,
java.lang.String[] groups,
int serverCode,
boolean override,
java.lang.String ruleBase,
boolean needValidation)
Write an XML file to the database, given a Reader |
static java.lang.String |
write(DBConnection conn,
java.io.Reader xml,
java.lang.String pub,
java.io.Reader dtd,
java.lang.String action,
java.lang.String docid,
java.lang.String user,
java.lang.String[] groups,
java.lang.String ruleBase,
boolean needValidation)
Write an XML file to the database, given a filename |
static void |
writeDataFileInReplication(java.io.InputStream input,
java.lang.String filePath,
java.lang.String docname,
java.lang.String doctype,
java.lang.String accnum,
java.lang.String user,
java.lang.String docHomeServer,
java.lang.String notificationServer)
This method will register a data file entry in xml_documents and save a data file input Stream into file system.. |
static java.lang.String |
writeReplication(DBConnection conn,
java.io.Reader xml,
java.lang.String pub,
java.io.Reader dtd,
java.lang.String action,
java.lang.String accnum,
java.lang.String user,
java.lang.String[] groups,
java.lang.String homeServer,
java.lang.String notifyServer,
java.lang.String ruleBase,
boolean needValidation)
Write an XML file to the database during replication |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String SCHEMA
public static final java.lang.String DTD
public static final java.lang.String EML200
public static final java.lang.String EML210
public static final java.lang.String EXTERNALSCHEMALOCATIONPROPERTY
public static final java.lang.String DECLARATIONHANDLERPROPERTY
public static final java.lang.String LEXICALPROPERTY
public static final java.lang.String VALIDATIONFEATURE
public static final java.lang.String SCHEMAVALIDATIONFEATURE
public static final java.lang.String NAMESPACEFEATURE
public static final java.lang.String NAMESPACEPREFIXESFEATURE
public static final java.lang.String EML2_1_0NAMESPACE
public static final java.lang.String EML2_0_1NAMESPACE
public static final java.lang.String EML2_0_0NAMESPACE
public static final java.lang.String DOCNAME
public static final java.lang.String PUBLICID
public static final java.lang.String SYSTEMID
Constructor Detail |
public DocumentImpl(java.lang.String docid, boolean readNodes) throws McdbException
docid
- the identifier of the document to be createdreadNodes
- flag indicating whether the xmlnodes should be readpublic DocumentImpl(java.lang.String docid) throws McdbException
docid
- the identifier of the document to be createdpublic DocumentImpl(DBConnection conn, long rootNodeId, java.lang.String docName, java.lang.String docType, java.lang.String docId, java.lang.String newRevision, java.lang.String action, java.lang.String user, java.lang.String pub, java.lang.String catalogId, int serverCode) throws java.sql.SQLException, java.lang.Exception
conn
- the JDBC Connection to which all information is writtenaction
- the action to be performed (INSERT OR UPDATE)user
- the user that owns the documentpub
- flag for public "read" access on documentserverCode
- the serverid from xml_replication on which this document
resides.Method Detail |
public static void registerDocument(java.lang.String docname, java.lang.String doctype, java.lang.String accnum, java.lang.String user, java.lang.String[] groupnames) throws java.sql.SQLException, AccessionNumberException, java.lang.Exception
java.sql.SQLException
AccessionNumberException
java.lang.Exception
public static void registerDocument(java.lang.String docname, java.lang.String doctype, java.lang.String accnum, java.lang.String user, java.lang.String[] groups, int serverCode) throws java.sql.SQLException, AccessionNumberException, java.lang.Exception
docname
- -
the name of DTD, i.e. the name immediately following the
DOCTYPE keyword ( should be the root element name ) or the
root element name if no DOCTYPE declaration provided (Oracle's
and IBM parsers are not aware if it is not the root element
name)doctype
- -
Public ID of the DTD, i.e. the name immediately following the
PUBLIC keyword in DOCTYPE declaration or the docname if no
Public ID provided or null if no DOCTYPE declaration providedaccnum
- the accession number to use for the INSERT OR UPDATE, which
includes a revision number for this revision of the document
(e.g., knb.1.1)user
- the user that owns the documentserverCode
- the serverid from xml_replication on which this document
resides.
java.sql.SQLException
AccessionNumberException
java.lang.Exception
public static void registerDocumentInReplication(java.lang.String docname, java.lang.String doctype, java.lang.String accnum, java.lang.String user, int serverCode) throws java.sql.SQLException, AccessionNumberException, java.lang.Exception
docname
- -
the name of DTD, i.e. the name immediately following the
DOCTYPE keyword ( should be the root element name ) or the
root element name if no DOCTYPE declaration provided (Oracle's
and IBM parsers are not aware if it is not the root element
name)doctype
- -
Public ID of the DTD, i.e. the name immediately following the
PUBLIC keyword in DOCTYPE declaration or the docname if no
Public ID provided or null if no DOCTYPE declaration providedaccnum
- the accession number to use for the INSERT OR UPDATE, which
includes a revision number for this revision of the document
(e.g., knb.1.1)user
- the user that owns the documentserverCode
- the serverid from xml_replication on which this document
resides.
java.sql.SQLException
AccessionNumberException
java.lang.Exception
public static void writeDataFileInReplication(java.io.InputStream input, java.lang.String filePath, java.lang.String docname, java.lang.String doctype, java.lang.String accnum, java.lang.String user, java.lang.String docHomeServer, java.lang.String notificationServer) throws java.sql.SQLException, AccessionNumberException, java.lang.Exception
docname
- -
the name of DTD, for data file, it is a docid number.doctype
- -
"BIN" for data fileaccnum
- the accession number to use for the INSERT OR UPDATE, which
includes a revision number for this revision of the document
(e.g., knb.1.1)user
- the user that owns the document
java.sql.SQLException
AccessionNumberException
java.lang.Exception
public static boolean getDataFileLockGrant(java.lang.String accnum) throws java.lang.Exception
java.lang.Exception
public static boolean getDataFileLockGrant(java.lang.String accnum, int serverCode) throws java.lang.Exception
java.lang.Exception
public java.lang.String getDocname()
public java.lang.String getDoctype()
public java.lang.String getSystemID()
public long getRootNodeID()
public java.lang.String getCreateDate()
public java.lang.String getUpdateDate()
public java.lang.String getDocID()
public java.lang.String getUserowner()
public java.lang.String getUserupdated()
public int getServerlocation()
public java.lang.String getDocHomeServer()
public java.lang.String getPublicaccess()
public int getRev()
public java.lang.String getValidateType()
public java.lang.String toString(java.lang.String user, java.lang.String[] groups, boolean withInlinedata)
public java.lang.String toString()
public java.lang.String readUsingSlowAlgorithm() throws McdbException
McdbException
public void toXml(java.io.Writer pw, java.lang.String user, java.lang.String[] groups, boolean withInLineData) throws McdbException
pw
- the Writer to which we print the document Now we decide no
matter withinInlineData's value, the document will
McdbException
public void buildIndex() throws McdbException
McdbException
- on error getting the node records for the documentpublic static java.lang.String write(DBConnection conn, java.io.Reader xml, java.lang.String pub, java.io.Reader dtd, java.lang.String action, java.lang.String docid, java.lang.String user, java.lang.String[] groups, java.lang.String ruleBase, boolean needValidation) throws java.lang.Exception
conn
- the JDBC connection to the databasepub
- flag for public "read" access on documentaction
- the action to be performed (INSERT OR UPDATE)docid
- the docid to use for the INSERT OR UPDATEuser
- the user that owns the documentgroups
- the groups to which user belongs
java.lang.Exception
public static java.lang.String write(DBConnection conn, java.io.Reader xml, java.lang.String pub, java.io.Reader dtd, java.lang.String action, java.lang.String accnum, java.lang.String user, java.lang.String[] groups, int serverCode, boolean override, java.lang.String ruleBase, boolean needValidation) throws java.lang.Exception
conn
- the JDBC connection to the databasexml
- the xml stream to be loaded into the databasepub
- flag for public "read" access on xml documentdtd
- the dtd to be uploaded on server's file systemaction
- the action to be performed (INSERT or UPDATE)accnum
- the docid + rev# to use on INSERT or UPDATEuser
- the user that owns the documentgroups
- the groups to which user belongsserverCode
- the serverid from xml_replication on which this document
resides.override
- flag to stop insert replication checking. if override = true
then a document not belonging to the local server will not be
checked upon update for a file lock. if override = false then
a document not from this server, upon update will be locked
and version checked.
java.lang.Exception
public static java.lang.String writeReplication(DBConnection conn, java.io.Reader xml, java.lang.String pub, java.io.Reader dtd, java.lang.String action, java.lang.String accnum, java.lang.String user, java.lang.String[] groups, java.lang.String homeServer, java.lang.String notifyServer, java.lang.String ruleBase, boolean needValidation) throws java.lang.Exception
conn
- the JDBC connection to the databasexml
- the xml stream to be loaded into the databasepub
- flag for public "read" access on xml documentdtd
- the dtd to be uploaded on server's file systemaction
- the action to be performed (INSERT or UPDATE)accnum
- the docid + rev# to use on INSERT or UPDATEuser
- the user that owns the documentgroups
- the groups to which user belongshomeServer
- the name of server which the document origanlly create
java.lang.Exception
public static void delete(java.lang.String accnum, java.lang.String user, java.lang.String[] groups, java.lang.String notifyServer) throws java.lang.Exception
java.lang.Exception
public static boolean hasReadPermission(java.lang.String user, java.lang.String[] groups, java.lang.String docId) throws java.sql.SQLException, java.lang.Exception
java.sql.SQLException
java.lang.Exception
public static int getLatestRevisionNumber(java.lang.String docId) throws java.sql.SQLException
java.sql.SQLException
public static void main(java.lang.String[] args)
Usage: java DocumentImpl <-f filename -a action -d docid>
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |