|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object fr.gouv.culture.sdx.utils.AbstractSdxObject fr.gouv.culture.sdx.utils.logging.LoggingIndexation
public class LoggingIndexation
Specific logger for indexation process.
This logger is specific to the indexation process. It manages all steps of indexation and log those informations according the logger type (currently a JDBC logger).
Messages are formated according the following pattern:
indexation ID
;document base id
;number of documents to index
;
start time
;end time
;number steps to proceed
;
current step
;current document rank
;current document start time
;
current document end time
;current document ID
;
current document attached number
;current document sub-documents documents number
;
current document attached rank
;current document sub-document rank
Some informations may be null (eg, the current document may not have sub-documents).
The default separator is a semi-colon ";
". This can be modified (@see #setSeparator(String)).
An ID is constructed for all indexation process according the pattern:
"indexation start time
." Adding the document ID is not necessary ; to add this information
you just have to configure the target logger (eg, WEB-INF/logkit.xconf) to managed this granularity. By default, the granularity
of this indexation logger is: "sdx.framework.indexation
".
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface fr.gouv.culture.sdx.utils.SdxObject |
---|
SdxObject.ConfigurationNode |
Field Summary | |
---|---|
static java.lang.String |
CLASS_NAME_SUFFIX
|
static java.lang.String |
DEFAULT_DATE_FORMAT
Default date format |
static java.lang.String |
DEFAULT_SEPARATOR
Default separator |
static int |
docMoreInfosOutput
The limit to output informations of each document |
static int |
LEVEL_DEBUG
Current logger level |
static java.lang.String |
LEVEL_DEBUG_STRING
String representation of the current logger level |
static int |
LEVEL_ERROR
|
static java.lang.String |
LEVEL_ERROR_STRING
|
static int |
LEVEL_FATAL
|
static java.lang.String |
LEVEL_FATAL_STRING
|
static int |
LEVEL_INFO
|
static java.lang.String |
LEVEL_INFO_STRING
|
static int |
LEVEL_OFF
|
static java.lang.String |
LEVEL_OFF_STRING
|
static int |
LEVEL_WARN
|
static java.lang.String |
LEVEL_WARN_STRING
|
org.apache.avalon.framework.logger.Logger |
logger
The current logger |
protected java.lang.String |
m_dateFormat
The format of date as a string |
protected java.lang.String |
m_dbid
The document base to index |
protected int |
m_doc_attached_rank
Current attached document rank |
protected long |
m_doc_end
Current document indexation end time |
protected java.lang.String |
m_doc_endFormatedDate
|
protected java.lang.String |
m_doc_id
The current document ID |
protected java.util.Hashtable |
m_doc_infos
Current document information Current document information such as: IDstartendnumber of sub-documentsnumber of attached documents |
protected int |
m_doc_nbattached
Number of attached documents for the current document |
protected int |
m_doc_nbsubdocs
Number of sub-documents for the current document |
protected int |
m_doc_rank
Current document rank |
protected long |
m_doc_start
Current document indexation start time |
protected java.lang.String |
m_doc_startFormatedDate
|
protected int |
m_doc_subdoc_rank
Current sub-document rank |
protected java.lang.String |
m_doc_subdocid
Current dub-document ID |
protected java.util.Hashtable |
m_docs_infos
Documents informations |
protected java.util.Hashtable |
m_docsadded
Documents added list |
protected java.util.Hashtable |
m_docserror
Documents error list |
protected java.util.Hashtable |
m_docserror_msg
Documents error messages |
protected long |
m_end
Indexation end time |
protected java.lang.String |
m_endFormatedDate
|
protected java.lang.String |
m_indexationID
Indexation ID |
protected int |
m_nbdocs
Number of documents concerned by this indexation |
protected int |
m_nbDocsAdded
Number of documents added |
protected int |
m_nbDocsError
Number of documents added |
java.lang.String |
m_separator
The separator used to format messages |
protected long |
m_start
Indexation start time |
protected java.lang.String |
m_startFormatedDate
|
protected int |
m_step
Current step |
protected int |
m_steps
Number of steps |
static int |
STEP_DOCUMENT_ADD
Adding the document |
static int |
STEP_DOCUMENT_ADD_ATTACHED_ADD
Adding the current attached document |
static java.lang.String |
STEP_DOCUMENT_ADD_ATTACHED_ADD_STRING
Adding the current attached document |
static int |
STEP_DOCUMENT_ADD_ATTACHED_END
End time for attached documents process |
static java.lang.String |
STEP_DOCUMENT_ADD_ATTACHED_END_STRING
End time for attached documents process |
static int |
STEP_DOCUMENT_ADD_ATTACHED_START
Start time for attached documents process |
static java.lang.String |
STEP_DOCUMENT_ADD_ATTACHED_START_STRING
Start time for attached documents process |
static int |
STEP_DOCUMENT_ADD_OAI_DELETED_RECORD
Updating the OAI repository for the current document |
static java.lang.String |
STEP_DOCUMENT_ADD_OAI_DELETED_RECORD_STRING
Updating the OAI repository for the current document |
static int |
STEP_DOCUMENT_ADD_SET_ID
Setting the ID of the document to index |
static java.lang.String |
STEP_DOCUMENT_ADD_SET_ID_STRING
Setting the ID of the document to index |
static int |
STEP_DOCUMENT_ADD_STORE_ORIGINAL_DOCUMENT
Adding the original document if needed |
static java.lang.String |
STEP_DOCUMENT_ADD_STORE_ORIGINAL_DOCUMENT_STRING
Adding the original document if needed |
static java.lang.String |
STEP_DOCUMENT_ADD_STRING
Adding the document |
static int |
STEP_DOCUMENT_ADD_SUBDOCUMENTS_ADD
Adding the current sub-document |
static java.lang.String |
STEP_DOCUMENT_ADD_SUBDOCUMENTS_ADD_STRING
Adding the current sub-document |
static int |
STEP_DOCUMENT_ADD_SUBDOCUMENTS_END
End time for sub-documents process |
static java.lang.String |
STEP_DOCUMENT_ADD_SUBDOCUMENTS_END_STRING
End time for sub-documents process |
static int |
STEP_DOCUMENT_ADD_SUBDOCUMENTS_START
Start time for sub-documents process |
static java.lang.String |
STEP_DOCUMENT_ADD_SUBDOCUMENTS_START_STRING
Start time for sub-documents process |
static int |
STEP_DOCUMENT_ADD_TO_REPOSITORY
Adding the current document to the documents repository |
static java.lang.String |
STEP_DOCUMENT_ADD_TO_REPOSITORY_STRING
Adding the current document to the documents repository |
static int |
STEP_DOCUMENT_ADD_TO_SEARCH_INDEX
Adding the current document to the search index |
static java.lang.String |
STEP_DOCUMENT_ADD_TO_SEARCH_INDEX_STRING
Adding the current document to the search index |
static int |
STEP_DOCUMENT_ADD_UPDATE_METADATA
Updating the internal database for the current document |
static java.lang.String |
STEP_DOCUMENT_ADD_UPDATE_METADATA_STRING
Updating the internal database for the current document |
static int |
STEP_DOCUMENT_INDEXATION_END
Document indexation end |
static java.lang.String |
STEP_DOCUMENT_INDEXATION_END_STRING
Document indexation end |
static int |
STEP_DOCUMENT_INDEXATION_START
Document indexation start |
static java.lang.String |
STEP_DOCUMENT_INDEXATION_START_STRING
Document indexation start |
static int |
STEP_DOCUMENT_TRANSFORMATION
Transforming of the document to index |
static int |
STEP_DOCUMENT_TRANSFORMATION_END
End time for the transformation of the document to index |
static java.lang.String |
STEP_DOCUMENT_TRANSFORMATION_END_STRING
End time for the transformation of the document to index |
static int |
STEP_DOCUMENT_TRANSFORMATION_START
Start time for the transformation of the document to index |
static java.lang.String |
STEP_DOCUMENT_TRANSFORMATION_START_STRING
Start time for the transformation of the document to index |
static java.lang.String |
STEP_DOCUMENT_TRANSFORMATION_STRING
Transforming of the document to index |
static int |
STEP_INDEXATION_END
Indexation end |
static java.lang.String |
STEP_INDEXATION_END_STRING
Indexation end |
static int |
STEP_INDEXATION_INIT
Indexation start |
static java.lang.String |
STEP_INDEXATION_INIT_STRING
Indexation start |
static int |
STEP_MERGE_BATCH_INDEX
Merging the batch indexes if needed |
static java.lang.String |
STEP_MERGE_BATCH_INDEX_STRING
Merging the batch indexes if needed |
static int |
STEP_OPTIMIZE_DOCUMENT_BASE
Optimizing the document base if needed |
static java.lang.String |
STEP_OPTIMIZE_DOCUMENT_BASE_STRING
Optimizing the document base if needed |
Fields inherited from class fr.gouv.culture.sdx.utils.AbstractSdxObject |
---|
_configuration, _context, _description, _encoding, _id, _locale, _logger, _manager, _xmlizable_objects, _xmlLang, isToSaxInitialized |
Fields inherited from interface fr.gouv.culture.sdx.utils.Encodable |
---|
DEFAULT_ENCODING |
Constructor Summary | |
---|---|
LoggingIndexation()
|
Method Summary | |
---|---|
void |
addAddedDoc(int rank,
java.lang.String docid)
|
void |
addErrorDoc(int rank,
java.lang.String docid)
|
void |
addErrorDoc(int rank,
java.lang.String docid,
java.lang.String message,
java.lang.Exception e)
|
void |
configure(org.apache.avalon.framework.configuration.Configuration conf,
java.lang.String dbid,
long start,
int nbdocs,
java.lang.String indexationID,
java.lang.String separator)
|
void |
configureLogger()
|
java.lang.String |
formatMessage()
|
java.util.Hashtable |
getAddedDocs()
|
protected java.lang.String |
getClassNameSuffix()
Sub classes should element this method to return their class name suffix for SAX output |
int |
getCurrentStep()
|
java.lang.String |
getDateFormat()
|
int |
getDocAttachedRank()
|
long |
getDocEnd()
|
java.lang.String |
getDocID()
|
static int |
getDocMoreInfosOutput()
|
int |
getDocNbAttached()
|
int |
getDocNbSubdocs()
|
int |
getDocRank()
|
int |
getDocStart()
|
int |
getDocSubdocRank()
|
long |
getEnd()
|
java.util.Hashtable |
getErrorDocs()
|
int |
getLevel()
|
java.lang.String |
getLevelString()
|
java.lang.String |
getSeparator()
|
long |
getStart()
|
java.lang.String |
getStepString()
|
void |
getXMLInformation()
|
protected boolean |
initToSax()
Init the LinkedHashMap _xmlizable_objects with the objects in order to describ them in XML |
protected void |
initVolatileObjectsToSax()
Init the LinkedHashMap _xmlizable_volatile_objects with the objects in order to describ them in XML Some objects need to be refresh each time a toSAX is called |
java.lang.String |
log()
|
void |
logAddedAndErrorDocs()
Logs all documents IDs (added documents and error documents). |
void |
logErrorsMessages()
Logs all error messages. |
void |
logInfo(java.lang.String message)
|
void |
setDateFormat(java.lang.String s)
|
void |
setDocAttachedRank(int attachedRank)
|
void |
setDocEnd(long docEnd)
|
void |
setDocID(java.lang.String docID)
|
static void |
setDocMoreInfosOutput(int docMoreInfosOutput)
|
void |
setDocNbAttached(int nbattached)
|
void |
setDocNbSubdocs(int nbsubdocs)
|
void |
setDocRank(int docRank)
|
void |
setDocStart(long docStart)
|
void |
setDocSubdocRank(int subdocRank)
|
void |
setEnd(long indexationEnd)
|
void |
setSeparator(java.lang.String s)
|
void |
setStart(long indexationStart)
|
void |
setStep(int currentStep)
|
void |
setSteps()
|
Methods inherited from class fr.gouv.culture.sdx.utils.AbstractSdxObject |
---|
configure, configureDescription, contextualize, enableLogging, getBaseAttributes, getConfiguration, getContext, getDescription, getEncoding, getId, getLocale, getLog, getServiceManager, getXmlLang, service, setDescription, setEncoding, setId, setLocale, setUpSdxObject, setUpSdxObject, setXmlLang, toSAX, verifyConfigurationResources |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CLASS_NAME_SUFFIX
public org.apache.avalon.framework.logger.Logger logger
protected java.lang.String m_indexationID
protected long m_start
protected java.lang.String m_startFormatedDate
protected long m_end
protected java.lang.String m_endFormatedDate
protected int m_nbdocs
protected int m_nbDocsAdded
protected int m_nbDocsError
protected java.lang.String m_dbid
protected java.lang.String m_doc_id
protected int m_doc_nbsubdocs
protected int m_doc_nbattached
protected long m_doc_start
protected java.lang.String m_doc_startFormatedDate
protected long m_doc_end
protected java.lang.String m_doc_endFormatedDate
protected int m_doc_rank
protected java.lang.String m_doc_subdocid
protected int m_doc_subdoc_rank
protected int m_doc_attached_rank
protected int m_steps
protected int m_step
protected java.util.Hashtable m_docsadded
protected java.util.Hashtable m_docserror
protected java.util.Hashtable m_docserror_msg
protected java.util.Hashtable m_docs_infos
protected java.util.Hashtable m_doc_infos
Current document information such as:
public java.lang.String m_separator
public static final java.lang.String DEFAULT_SEPARATOR
protected java.lang.String m_dateFormat
public static final java.lang.String DEFAULT_DATE_FORMAT
public static int docMoreInfosOutput
public static final int STEP_INDEXATION_INIT
public static final int STEP_DOCUMENT_INDEXATION_START
public static final int STEP_DOCUMENT_TRANSFORMATION
public static final int STEP_DOCUMENT_TRANSFORMATION_START
public static final int STEP_DOCUMENT_TRANSFORMATION_END
public static final int STEP_DOCUMENT_ADD
public static final int STEP_DOCUMENT_ADD_SET_ID
public static final int STEP_DOCUMENT_ADD_STORE_ORIGINAL_DOCUMENT
public static final int STEP_DOCUMENT_ADD_ATTACHED_START
public static final int STEP_DOCUMENT_ADD_ATTACHED_ADD
public static final int STEP_DOCUMENT_ADD_ATTACHED_END
public static final int STEP_DOCUMENT_ADD_SUBDOCUMENTS_START
public static final int STEP_DOCUMENT_ADD_SUBDOCUMENTS_ADD
public static final int STEP_DOCUMENT_ADD_SUBDOCUMENTS_END
public static final int STEP_DOCUMENT_ADD_TO_SEARCH_INDEX
public static final int STEP_DOCUMENT_ADD_OAI_DELETED_RECORD
public static final int STEP_DOCUMENT_ADD_TO_REPOSITORY
public static final int STEP_DOCUMENT_ADD_UPDATE_METADATA
public static final int STEP_DOCUMENT_INDEXATION_END
public static final int STEP_MERGE_BATCH_INDEX
public static final int STEP_OPTIMIZE_DOCUMENT_BASE
public static final int STEP_INDEXATION_END
public static final java.lang.String STEP_INDEXATION_INIT_STRING
public static final java.lang.String STEP_DOCUMENT_INDEXATION_START_STRING
public static final java.lang.String STEP_DOCUMENT_TRANSFORMATION_STRING
public static final java.lang.String STEP_DOCUMENT_TRANSFORMATION_START_STRING
public static final java.lang.String STEP_DOCUMENT_TRANSFORMATION_END_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_SET_ID_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_STORE_ORIGINAL_DOCUMENT_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_ATTACHED_START_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_ATTACHED_ADD_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_ATTACHED_END_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_SUBDOCUMENTS_START_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_SUBDOCUMENTS_ADD_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_SUBDOCUMENTS_END_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_TO_SEARCH_INDEX_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_OAI_DELETED_RECORD_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_TO_REPOSITORY_STRING
public static final java.lang.String STEP_DOCUMENT_ADD_UPDATE_METADATA_STRING
public static final java.lang.String STEP_DOCUMENT_INDEXATION_END_STRING
public static final java.lang.String STEP_MERGE_BATCH_INDEX_STRING
public static final java.lang.String STEP_OPTIMIZE_DOCUMENT_BASE_STRING
public static final java.lang.String STEP_INDEXATION_END_STRING
public static final int LEVEL_DEBUG
public static final int LEVEL_INFO
public static final int LEVEL_WARN
public static final int LEVEL_ERROR
public static final int LEVEL_FATAL
public static final int LEVEL_OFF
public static final java.lang.String LEVEL_DEBUG_STRING
public static final java.lang.String LEVEL_ERROR_STRING
public static final java.lang.String LEVEL_INFO_STRING
public static final java.lang.String LEVEL_WARN_STRING
public static final java.lang.String LEVEL_FATAL_STRING
public static final java.lang.String LEVEL_OFF_STRING
Constructor Detail |
---|
public LoggingIndexation()
Method Detail |
---|
public void configure(org.apache.avalon.framework.configuration.Configuration conf, java.lang.String dbid, long start, int nbdocs, java.lang.String indexationID, java.lang.String separator) throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
public void setSteps()
public void configureLogger()
public java.lang.String log()
public void logInfo(java.lang.String message)
public java.lang.String formatMessage()
public void logAddedAndErrorDocs()
The log is formated as below:
{Indexation ID};{sdxdbid};{nb docs to index};{start time};{end time};ADDED_ERROR_DOCS_ID;{docs added IDs list};{docs error IDs list}
public void logErrorsMessages()
The log is formated as below:
{Indexation ID};{sdxdbid};{nb docs to index};{start time};{end time};ERROR_MESSAGES;{error messages list}
public void setSeparator(java.lang.String s)
public java.lang.String getSeparator()
public void setDateFormat(java.lang.String s)
public java.lang.String getDateFormat()
public void setStep(int currentStep)
public int getCurrentStep()
public void setStart(long indexationStart)
public long getStart()
public void setEnd(long indexationEnd)
public long getEnd()
public void setDocID(java.lang.String docID)
public java.lang.String getDocID()
public void setDocRank(int docRank)
public int getDocRank()
public void addErrorDoc(int rank, java.lang.String docid)
public void addErrorDoc(int rank, java.lang.String docid, java.lang.String message, java.lang.Exception e)
public java.util.Hashtable getErrorDocs()
public void addAddedDoc(int rank, java.lang.String docid)
public java.util.Hashtable getAddedDocs()
public static int getDocMoreInfosOutput()
public static void setDocMoreInfosOutput(int docMoreInfosOutput)
public void setDocStart(long docStart)
public int getDocStart()
public void setDocEnd(long docEnd)
public long getDocEnd()
public void setDocNbSubdocs(int nbsubdocs)
public int getDocNbSubdocs()
public void setDocNbAttached(int nbattached)
public int getDocNbAttached()
public void setDocSubdocRank(int subdocRank)
public int getDocSubdocRank()
public void setDocAttachedRank(int attachedRank)
public int getDocAttachedRank()
public int getLevel()
public java.lang.String getLevelString()
public java.lang.String getStepString()
protected java.lang.String getClassNameSuffix()
AbstractSdxObject
getClassNameSuffix
in class AbstractSdxObject
protected boolean initToSax()
AbstractSdxObject
initToSax
in class AbstractSdxObject
protected void initVolatileObjectsToSax()
AbstractSdxObject
initVolatileObjectsToSax
in class AbstractSdxObject
public void getXMLInformation()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |