com.raritantechnologies.documentum.formatters
Class DocumentumFolderPathFormatter

java.lang.Object
  com.raritantechnologies.documentum.formatters.DocumentumFolderPathFormatter

All Implemented Interfaces:

IConfigurable, IFieldFormatter

public class DocumentumFolderPathFormatter

extends java.lang.Object

implements IFieldFormatter

FieldFormatter that gets the folder paths for a Documentum object.

XML Configuration Template:

   <FieldFormatter class="com.raritantechnologies.documentum.formatters.DocumentumFolderFormatter"
                       objectIDField="[field name of field with Object ID]"
                      docbaseURI="[docbase name]"
                      defaultUser="[documentum userID]"
                      defaultPassword="[documentum password]"
                      outputIDPrefix="[prefix used for folder path fields]">
   </FieldFormatter>












Field Summary

 
Fields inherited from interface com.raritantechnologies.searchApp.IFieldFormatter
TEMPLATE
 



Constructor Summary
DocumentumFolderPathFormatter()



           
 



Method Summary




 java.lang.String
formatField(java.lang.String fieldVal)



          Reformats a field value.



 java.lang.String
formatField(java.lang.String sessionID,
            java.lang.String fieldVal)



          Reformats a field value.



 void
formatResultField(IResult result)



          Formats a result field "in place".



 void
formatResultField(java.lang.String sessionID,
                  IResult result)



          Formats a result field "in place", incorporating session context.



 java.lang.String
getConfigurationXML()



           



 java.lang.String
getConfigurationXML(java.lang.String configurationTemplate)



           



 java.lang.String
getFieldName()



          Returns the name of the result field that this formatter can reformat.



 void
initialize(org.w3c.dom.Element elem)



          Initializes the formatter from configuration XML element.


 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 








Constructor Detail



DocumentumFolderPathFormatter
public DocumentumFolderPathFormatter()






Method Detail



formatField
public java.lang.String formatField(java.lang.String sessionID,
                                    java.lang.String fieldVal)

Description copied from interface: IFieldFormatter
Reformats a field value.


Specified by:
formatField in interface IFieldFormatter


Parameters:
sessionID - The session key needed to lookup any session content stored
                          in the session data cache.
fieldVal - The field value to be reformatted.
Returns:
The reformatted field value.





formatField
public java.lang.String formatField(java.lang.String fieldVal)

Description copied from interface: IFieldFormatter
Reformats a field value.


Specified by:
formatField in interface IFieldFormatter


Parameters:
fieldVal - The field value to be reformatted.
Returns:
The reformatted field value.





formatResultField
public void formatResultField(java.lang.String sessionID,
                              IResult result)

Description copied from interface: IFieldFormatter
Formats a result field "in place", incorporating session context.


Specified by:
formatResultField in interface IFieldFormatter


Parameters:
sessionID - The session key needed to lookup any session content stored
                          in the session data cache.
result - The result object that is to be formatted.





formatResultField
public void formatResultField(IResult result)

Description copied from interface: IFieldFormatter
Formats a result field "in place".


Specified by:
formatResultField in interface IFieldFormatter


Parameters:
result - The result object that is to be formatted.





getFieldName
public java.lang.String getFieldName()

Description copied from interface: IFieldFormatter
Returns the name of the result field that this formatter can reformat.


Specified by:
getFieldName in interface IFieldFormatter








initialize
public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IFieldFormatter
Initializes the formatter from configuration XML element.


Specified by:
initialize in interface IFieldFormatter








getConfigurationXML
public java.lang.String getConfigurationXML()


Specified by:
getConfigurationXML in interface IFieldFormatter








getConfigurationXML
public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)


Specified by:
getConfigurationXML in interface IFieldFormatter