== Cache Custom Report Tag ==

This custom tags provide graphical standard reports, that are useful in determining the current state of the Cache.

=== cacheReport ===

'''Syntax'''

<source lang="coldfusion">
<cacheReport 
     monitor = cache monitor cfc
     mode = basic|detail
     chartsize = "size of chart"
     >
</query>
</source>

'''Attributes'''

{| border="1" cellpadding="2"
! Attribute
! Req/Opt
! Default
! Description
|- 
| monitor
| Required
| -
| The CacheMonitor library, as returned from transferFactory.getTransfer().getCacheMonitor
|-
| mode
| Optional
| 'basic'
| ''basic'': Gives a short overview of the cache state, with graphs displaying the totals, and the overall hit miss ratio. <br/> ''detail': Shows graphical statistics on each of the classes that are currently in cache.
|-
| chartsize
| Optional
| 400
| The size of each of the charts, in pixels.
|}


=== Examples ===

<source lang="coldfusion">

<cfimport prefix="report" taglib="/transfer/tags/reports">

<!--- Basic Report --->

<p>
<report:cacheReport monitor="#application.transferFactory.getTransfer().getCacheMonitor()#">
</p>

<!--- Detailed Report --->

<p>
<report:cacheReport monitor="#application.transferFactory.getTransfer().getCacheMonitor()#" mode="detail" chartsize="300">
</p>

</source>

[[Category:Cache]]