|
|||||||||
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.nucleus.TimedOperationService atg.repository.search.indexing.refinement.RefineConfigXMLGenerator
public class RefineConfigXMLGenerator
Service to generate ATG Search refinement configuration XML from refinement repository data.
Field Summary | |
---|---|
static java.lang.String |
BUNDLE_NAME
|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
PROPERTY_NOT_FOUND
|
static java.util.ResourceBundle |
sResources
|
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 | |
---|---|
RefineConfigXMLGenerator()
|
Method Summary | |
---|---|
protected org.w3c.dom.Document |
createDocument()
Create a new DOM document, using the document builder. |
protected org.w3c.dom.Document |
createRefineConfigDocument(java.util.List pRefineElementItemList,
RefineConfigXMLInfo pInfo)
Create a refinement confiugration DOM document from the given name and list of refinement element repository items. |
protected org.w3c.dom.Element |
createRefineElement(org.w3c.dom.Document pDocument,
RefinementElement pRefineElement)
Create a refinement element DOM element from the given refinement element repository item. |
void |
generateRefineConfigXML(RepositoryItem pRefineConfig,
RefineConfigXMLInfo pInfo,
java.io.OutputStream pOut)
Generate a refinement configuration XML to the given output stream. |
void |
generateRefineConfigXML(java.lang.String pName,
java.util.List pRefineElementItemList,
RefineConfigXMLInfo pInfo,
java.io.OutputStream pOut)
Generate a refinement configuration given a name and a list of refinement elements. |
java.lang.String |
getApplicationName()
|
java.util.Map |
getDelimitedPropertyToAttributeMap()
Gets the map used to translate refinement element item property names to attribute names used in the output XML. |
java.io.File |
getDestinationDirectory()
|
javax.xml.parsers.DocumentBuilder |
getDocumentBuilder()
Gets the document builder that will be used to create DOM documents. |
java.lang.String[] |
getFilterProperties()
Gets the list of properties whose refinement Elements not be filtered by the search engine. |
protected boolean |
getFilterValue(RefinementElement pRefinementElement)
Determines whether or not this facet should be filtered by the search engine. |
MetaPropertiesHelper |
getMetaPropertiesHelper()
Return MetaPropertisHelper |
protected RefinementElement[] |
getPrioritizedRefineElements(java.util.List pRefineElements)
Sorts the list of refine elements using the priority comparator. |
java.util.Comparator |
getPriorityComparator()
Gets the comparator that can be used to sort refinement elements. |
RefinementConfigurationPropertyManager |
getRefinementConfigurationPropertyManager()
Gets the refinement configuration property manager. |
protected RefinementElement |
getRefinementElementForItem(RepositoryItem pItem)
Get a refinement element object for the given refinement element repository item. |
RefinementElementPropertyManager |
getRefinementElementPropertyManager()
Gets the refinement element property manager. |
java.util.Map |
getSimplePropertyToAttributeMap()
Gets the map used to translate refinement element item property names to attribute names used in the output XML. |
javax.xml.transform.Transformer |
getTransformer()
Gets the XML Transformer that will generate the XML stream from a DOM tree. |
java.lang.String |
getValueDelimiter()
Sets the String used to delimit values of collection attributes. |
protected double |
roundTo2Dec(double pDouble)
Utility method to round a double to 2 decimal places |
void |
setApplicationName(java.lang.String pApplicationName)
|
void |
setDelimitedPropertyToAttributeMap(java.util.Map pDPTAM)
Sets the map used to translate refinement element item property names to attribute names used in the output XML. |
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 |
setFilterProperties(java.lang.String[] pFilterProperties)
Sets the list of properties whose refinement Elements will not be filtered by the search engine. |
void |
setMetaPropertiesHelper(MetaPropertiesHelper pMetaPropertiesHelper)
Sets MetaPropertiesHelper |
void |
setPriorityComparator(java.util.Comparator pComparator)
Sets the comparator that can be used to sort refinement elements. |
void |
setRefinementConfigurationPropertyManager(RefinementConfigurationPropertyManager pManager)
Sets the refinement configuration property manager. |
void |
setRefinementElementPropertyManager(RefinementElementPropertyManager pManager)
Sets the refinement element property manager. |
void |
setSimplePropertyToAttributeMap(java.util.Map pSPTAM)
Sets the map used to translate refinement element item property names to attribute names used in the output XML. |
void |
setTransformer(javax.xml.transform.Transformer pTransformer)
Sets the XML Transformer that will generate the XML stream from a DOM tree. |
void |
setValueDelimiter(java.lang.String pValueDelimiter)
Sets the String used to delimit values of collection attributes. |
protected void |
transformToXML(org.w3c.dom.Node pDocument,
java.io.OutputStream pOut)
Transform a DOM Document object to an XML output stream. |
protected java.util.List<java.lang.String> |
validateRefineElement(RefinementElement pRefineElement)
|
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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
public static final java.lang.String BUNDLE_NAME
public static final java.util.ResourceBundle sResources
public static final java.lang.String PROPERTY_NOT_FOUND
Constructor Detail |
---|
public RefineConfigXMLGenerator()
Method Detail |
---|
public java.io.File getDestinationDirectory()
public void setDestinationDirectory(java.io.File pDestinationDirectory)
public java.lang.String getApplicationName()
public void setApplicationName(java.lang.String pApplicationName)
public void setSimplePropertyToAttributeMap(java.util.Map pSPTAM)
public java.util.Map getSimplePropertyToAttributeMap()
public void setDelimitedPropertyToAttributeMap(java.util.Map pDPTAM)
public java.util.Map getDelimitedPropertyToAttributeMap()
public void setValueDelimiter(java.lang.String pValueDelimiter)
public java.lang.String getValueDelimiter()
public void setFilterProperties(java.lang.String[] pFilterProperties)
public java.lang.String[] getFilterProperties()
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()
public void setRefinementConfigurationPropertyManager(RefinementConfigurationPropertyManager pManager)
public RefinementConfigurationPropertyManager getRefinementConfigurationPropertyManager()
public void setRefinementElementPropertyManager(RefinementElementPropertyManager pManager)
public RefinementElementPropertyManager getRefinementElementPropertyManager()
public void setPriorityComparator(java.util.Comparator pComparator)
public java.util.Comparator getPriorityComparator()
public MetaPropertiesHelper getMetaPropertiesHelper()
public void setMetaPropertiesHelper(MetaPropertiesHelper pMetaPropertiesHelper)
pMetaPropertiesHelper
- MetaPropertiesHelperprotected org.w3c.dom.Document createDocument()
public void generateRefineConfigXML(RepositoryItem pRefineConfig, RefineConfigXMLInfo pInfo, java.io.OutputStream pOut)
public void generateRefineConfigXML(java.lang.String pName, java.util.List pRefineElementItemList, RefineConfigXMLInfo pInfo, java.io.OutputStream pOut)
protected void transformToXML(org.w3c.dom.Node pDocument, java.io.OutputStream pOut)
protected org.w3c.dom.Document createRefineConfigDocument(java.util.List pRefineElementItemList, RefineConfigXMLInfo pInfo)
protected java.util.List<java.lang.String> validateRefineElement(RefinementElement pRefineElement)
protected org.w3c.dom.Element createRefineElement(org.w3c.dom.Document pDocument, RefinementElement pRefineElement)
protected RefinementElement[] getPrioritizedRefineElements(java.util.List pRefineElements)
protected RefinementElement getRefinementElementForItem(RepositoryItem pItem) throws RepositoryException
RepositoryException
protected boolean getFilterValue(RefinementElement pRefinementElement)
pRefinementElement
- RepositoryItem refineElement to check
protected double roundTo2Dec(double pDouble)
pDouble
- double value to round
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |