|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.repository.search.indexing.config.SearchUpdateXMLGenerator
public class SearchUpdateXMLGenerator
The SearchUpdateXMLGenerator is a Nucleus service that takes a list of SearchUpdateOutputProperty item and creates XML for the search engine. This XML uses the schema defined by ATG Search. The generator creates a W3C DOM object and uses Java's built in XML classes to create the XML stream from DOM Document. This can also be changed by setting the "transformer" property, or subclassing and extending the "transformToXML" method.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
SearchUpdateXMLGenerator()
|
Method Summary | |
---|---|
protected org.w3c.dom.Document |
createDocument()
Create a new DOM document, using the document builder. |
protected void |
createPropertyElement(SearchUpdateOutputProperty pProperty,
org.w3c.dom.Element pPropertyReportType,
org.w3c.dom.Document pDocument)
Creates property element |
protected void |
createPropertyReportElement(java.util.List pProperties,
org.w3c.dom.Element pQueryReport,
org.w3c.dom.Document pDocument)
creates property report element |
protected void |
createQueryReportElement(java.util.List pProperties,
org.w3c.dom.Document pDocument)
creates query report element |
void |
generateXMLForProperties(java.lang.String pId,
java.util.List pProperties,
java.io.OutputStream pOut)
Generates query report XML into the output stream. |
java.io.File |
getDestinationDirectory()
|
javax.xml.parsers.DocumentBuilder |
getDocumentBuilder()
|
javax.xml.transform.Transformer |
getTransformer()
Gets the XML Transformer that will generate the XML stream from a DOM tree. |
void |
setDestinationDirectory(java.io.File pDestinationDirectory)
|
void |
setDocumentBuilder(javax.xml.parsers.DocumentBuilder pDocumentBuilder)
Sets the document builder that will be used to create DOM documents. |
void |
setTransformer(javax.xml.transform.Transformer pTransformer)
Sets the XML Transformer that will generate the XML stream from a DOM tree. |
protected void |
transformToXML(org.w3c.dom.Document pDocument,
java.io.OutputStream pOut)
Transform a DOM Document object to an XML output stream. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public SearchUpdateXMLGenerator()
Method Detail |
---|
public java.io.File getDestinationDirectory()
public void setDestinationDirectory(java.io.File pDestinationDirectory)
public javax.xml.transform.Transformer getTransformer()
public void setTransformer(javax.xml.transform.Transformer pTransformer)
public void setDocumentBuilder(javax.xml.parsers.DocumentBuilder pDocumentBuilder)
public javax.xml.parsers.DocumentBuilder getDocumentBuilder()
protected org.w3c.dom.Document createDocument()
protected void createPropertyElement(SearchUpdateOutputProperty pProperty, org.w3c.dom.Element pPropertyReportType, org.w3c.dom.Document pDocument)
protected void createPropertyReportElement(java.util.List pProperties, org.w3c.dom.Element pQueryReport, org.w3c.dom.Document pDocument)
protected void createQueryReportElement(java.util.List pProperties, org.w3c.dom.Document pDocument)
protected void transformToXML(org.w3c.dom.Document pDocument, java.io.OutputStream pOut)
public void generateXMLForProperties(java.lang.String pId, java.util.List pProperties, java.io.OutputStream pOut) throws SearchUpdateException
pId
- String identifier for this xml - used for logging/debugpProperties
- List of SearchUpdateOutputProperty objects to use to generate XML.pOut
- output stream
SearchUpdateException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |