qKc@sdZddd!Zddd!Zddd!ZddklZd efd YZd efd YZd efdYZdefdYZ defdYZ defdYZ defdYZ dS(s $RCSfile: interfaces.py,v $ Product interfaces Author: Philipp von Weitershausen $Id: interfaces.py,v 1.3 2003/06/16 05:47:53 arielpartners Exp $ s $Name: $iis$Date: 2003/06/16 05:47:53 $s$Revision: 1.3 $i i(t Interfacet IXMLMethodcBsDeZdZdZdZdZdZdZdZRS(so Base Method interface. Classes never implement this interface directly, only derived interfaces. cCsdS(sI Return names of currently available processor libraries N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytavailableProcessorsscCsdS(sI Obtain the object encapsulating the selected processor. N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt processorscCsdS(s] Retrieves the source Zope object (for XML content) via acquisition. N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytgetXmlSourceObject!scCsdS(s2same as changing the property. For use in scriptsN((t debugLevel((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt setDebugLevel'scCsdS(s+Return true if and only if debugging is on.N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt isDebugging*scCsdS(si Return list of meta types for standard zope objects this method can behave like N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytbehaveLikeList-s( t__name__t __module__t__doc__RRRRRR(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyRs     tIDTDValidateMethodcBs eZdZdZdZRS(s Automatically validates an XML document against its DTD, where the XML document is obtained from another Zope object via acquisition. cCsdS(s(Return results of validation as a stringN((tREQUEST((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytvalidationResultsString9scCsdS(sp Return boolean indicating whether passed in document is valid with respect to this DTD N((R ((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytisValid<s(R R R RR(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyR 3s t IXPathMethodcBseZdZdZRS(s Automatically filters an XML document via XPath, where the XML document is obtained from another Zope object via acquisition. cCsdS(s] Generate results using xpath expression and return them as a string N((R ((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytevaluateHs(R R R R(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyRBst IXSLTMethodcBsAeZdZdZdZddZddZdZRS(s Automatically transforms an XML document via XSLT, where the XML document is obtained from another Zope object via acquisition. cCsdS(sx Obtain the Zope object holding the XSLT, or None if the name does not point to a valid object. N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytgetXslTransformerTscCsdS(s>Generate results using transformer and return them as a stringN((R ((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt transformZscCsdS(s2same as changing the property. For use in scriptsN((R ((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt setCachingOn]scCsdS(s2same as changing the property. For use in scriptsN((R ((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt setCachingOff`scCsdS(s#Return TRUE if caching is turned onN((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt isCachingOncsN( R R R RRtNoneRRR(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyRNs     t ICacheManagercBsMeZdZdZdZdZdZdZdZdZ RS(s3 XML Method Cache Manager public interface cCsdS(s Turns caching on for all instances of all types of XML filters within the scope of this cache manager. N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytbatchSetCachingOnkscCsdS(s Turns caching off for all instances of all types of XML filters within the scope of this cache manager. N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytbatchSetCachingOffqscCsdS(s Return the last modified time of the cache file for the passed in URL 'url', or 0 if the cache file does not exist N((turl((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytcacheFileTimeStampxscCsdS(s Retrieve the output from the cache for the passed in URL 'url', or None if the cache file does not exist. N((R((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytvalueFromCache~scCsdS(s Save some contents 'contents' to the cache for the passed in URL 'url'. It will overwrite the previous contents of the cache file, or create a new cache file if it does not yet exist. N((Rtcontents((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt saveToCachescCsdS(si Clear the cache. This involves removing every cache file from the file system. N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt clearCachescCsdS(s7 Return the list of files in the cache N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytlistCacheFiless( R R R RRRRR R!R"(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyRfs      tIGeneratorRegistrycBs,eZdZdZdZdZRS(cCsdS(sK Register generator object 'obj' for meta type 'meta_type' N((t meta_typetobj((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytregisterscCsdS(sC Return generator object for meta type 'meta_type' N((R$((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt getGeneratorscCsdS(s1 Return default generator object N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytgetDefaultGeneratorscCsdS(s= Return a sequence with supported meta types N((((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pytsupportedMetaTypess(R R R&R'R(R)(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyR#s   t IGeneratorcBs&eZdZdZdddZRS(s) Interface for Output Generators cKsdS(s9 Create the object and return its result N((tidttitlet rawStringtkw((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt createObjectscCsdS(s7 Call the object and return its result N((R%tclientR tRESPONSE((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt getResultsN(R R R R/RR2(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyR*s N( R t __cvstag__t__date__t __version__tzope.interfaceRRR RRRR#R*(((s//srv/Zope/Products/ZopeXMLMethods/interfaces.pyt s   " U