public class PageSetDB extends DBPersist
PageSet database index
Modifier and Type | Field and Description |
---|---|
static short |
ClassId |
Constructor and Description |
---|
PageSetDB() |
PageSetDB(JDCConnection oConn,
java.lang.String sPageSetGUID) |
Modifier and Type | Method and Description |
---|---|
void |
addBlackList(java.lang.String[] aEMails) |
void |
addRecipients(java.lang.String[] aEMails) |
void |
clearRecipients() |
void |
clone(JDCConnection oConn,
java.lang.String sProtocol,
java.lang.String sStorage,
PageSetDB oSource)
Clone another page set including all its pages into current object instance
Both database registers and XML and HTML files are cloned.
|
boolean |
delete(JDCConnection oConn)
Delete a register from database
The deleted register will be the one matching this DBPersist primary key,
as set at constructor or load() method.
|
static boolean |
delete(JDCConnection oConn,
java.lang.String sPageSetGUID) |
boolean |
existsFile() |
static java.lang.String |
filePath(JDCConnection oConn,
java.lang.String sPageSetGUID)
Get relative path to XML data file
Relative path is readed from field path_data of table k_pagesets.
|
java.lang.String |
getAllowPattern() |
java.lang.String[] |
getBlackList() |
java.lang.String |
getDenyPattern() |
PageDB |
getFirstPage(JDCConnection oConn)
First Page of this PageSet
|
PageDB[] |
getPages(JDCConnection oConn)
Pages of this PageSet
|
PageSet |
getPageSet(JDCConnection oConn,
java.lang.String sBasePath) |
java.lang.String[] |
getRecipients() |
boolean |
load(JDCConnection oConn,
java.lang.Object[] aPK)
Load the internal value set from a register at a database table
|
void |
setAllowPattern(java.lang.String sAllowPattern) |
void |
setDenyPattern(java.lang.String sDenyPattern) |
void |
setPage(JDCConnection oConn,
java.lang.String sIdPage,
int iPgPage,
java.lang.String sTlPage,
java.lang.String sPathPage) |
boolean |
store(JDCConnection oConn)
Store a register at database representing this instance of DBPersist
Insertions and updates : The store method automatically manages
register insertions and updates.
|
allcaps, allcaps, clear, clone, columns, containsKey, containsValue, entrySet, exists, get, get, getAuditClassName, getCreationDate, getDate, getDate, getDateFormated, getDateShort, getDateTime, getDateTime24, getDecimal, getDecimalFormated, getDecimalFormated, getDouble, getDoubleFormated, getFloat, getFloatFormated, getInt, getIntArray, getInteger, getIntegerArray, getIntervalPart, getItemMap, getItems, getMoney, getPrimaryKey, getShort, getSQLDate, getSQLTime, getString, getStringHtml, getStringNull, getTable, getTable, getTime, getTimeOfDay, getTimestamp, isEmpty, isNull, iterator, keySet, load, parseXML, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putAll, putAll, remove, remove, replace, replace, replace, replace, replace, replace, replace, replace, setAuditTransact, setAuditUser, setCreationDate, setPrimaryKey, size, toLowerCase, toUpperCase, toXML, toXML, toXML, values
public static final short ClassId
public PageSetDB()
public PageSetDB(JDCConnection oConn, java.lang.String sPageSetGUID) throws java.sql.SQLException
java.sql.SQLException
public PageSet getPageSet(JDCConnection oConn, java.lang.String sBasePath) throws java.sql.SQLException, java.lang.ClassNotFoundException, java.lang.Exception
java.sql.SQLException
java.lang.ClassNotFoundException
java.lang.Exception
public boolean load(JDCConnection oConn, java.lang.Object[] aPK) throws java.sql.SQLException
DBPersist
Load the internal value set from a register at a database table
public boolean store(JDCConnection oConn) throws java.sql.SQLException
DBPersist
Store a register at database representing this instance of DBPersist
Insertions and updates : The store method automatically manages register insertions and updates. If the stored object already exists at database then it is updated, if it does not exists then it is inserted. A primary key violation error is never thrown so ther is no need to call delete() method before re-writing an existing object.
NULL fields : All values not set calling put() methods for DBPersist
will be assumed to be NULL. If a not nullable field is not set then an
SQLException will be raised.
On storing an already existing object all values will we overwrited,
so is a DBPersist is not fully loaded before storing it, values not set
by calling put() methods that already were present at database will be lost.
public boolean delete(JDCConnection oConn) throws java.sql.SQLException
DBPersist
Delete a register from database
The deleted register will be the one matching this DBPersist primary key, as set at constructor or load() method.
public boolean existsFile()
public void setPage(JDCConnection oConn, java.lang.String sIdPage, int iPgPage, java.lang.String sTlPage, java.lang.String sPathPage) throws java.sql.SQLException
java.sql.SQLException
public static java.lang.String filePath(JDCConnection oConn, java.lang.String sPageSetGUID) throws java.sql.SQLException
Get relative path to XML data file
Relative path is readed from field path_data of table k_pagesets.oConn
- Database ConnectionsPageSetGUID
- GUID of PageSet witch data file relative path is to be retrievedjava.sql.SQLException
public PageDB getFirstPage(JDCConnection oConn) throws java.sql.SQLException
oConn
- Database Connectionjava.sql.SQLException
public PageDB[] getPages(JDCConnection oConn) throws java.sql.SQLException
oConn
- Database Connectionjava.sql.SQLException
public void clone(JDCConnection oConn, java.lang.String sProtocol, java.lang.String sStorage, PageSetDB oSource) throws java.io.IOException, java.sql.SQLException
Clone another page set including all its pages into current object instance
Both database registers and XML and HTML files are cloned.oConn
- JDCConnectionsProtocol
- File transfer protocol (usually "file://") if null then file:// is the defaultsStorage
- String Absolute path to storage directory (from storage property of hipergate.cnf file)oSource
- Source PageSetDB object instance to be clonedjava.io.IOException
java.sql.SQLException
public java.lang.String[] getBlackList()
public void addBlackList(java.lang.String[] aEMails) throws org.apache.oro.text.regex.MalformedPatternException
org.apache.oro.text.regex.MalformedPatternException
public void clearRecipients()
public java.lang.String[] getRecipients()
public java.lang.String getAllowPattern()
public void setAllowPattern(java.lang.String sAllowPattern)
public java.lang.String getDenyPattern()
public void setDenyPattern(java.lang.String sDenyPattern)
public void addRecipients(java.lang.String[] aEMails) throws java.lang.ArrayIndexOutOfBoundsException, org.apache.oro.text.regex.MalformedPatternException
java.lang.ArrayIndexOutOfBoundsException
org.apache.oro.text.regex.MalformedPatternException
public static boolean delete(JDCConnection oConn, java.lang.String sPageSetGUID) throws java.sql.SQLException
java.sql.SQLException