JSCAPE MFT Server

com.jscape.inet.mft.subsystems.reporting
Interface MetricsFormatter

All Known Implementing Classes:
DailyStatisticsFormatter, GeneralStatisticsFormatter, HourlyStatisticsFormatter, HtmlMetricsFormatter, LastUserLogonFormatter, MonthlyStatisticsFormatter, TopAttachmentsReceivedFormatter, TopAttachmentsSentFormatter, TopDownloadsFormatter, TopErrorsFormatter, TopExternalDownloadsFormatter, TopExternalUploadsFormatter, TopHostsFormatter, TopUploadsFormatter, TopUsersFormatter, UserDetailFormatter

public interface MetricsFormatter

Metrics formatter.

Author:
Alex Usun

Nested Class Summary
static class MetricsFormatter.FormatterException
          Formatter error.
 
Method Summary
 java.lang.String format(Metrics metrics, com.jscape.inet.mft.subsystems.reporting.FormatEnvironment environment)
          Formats the specified metrics.
 java.lang.String getMimeType()
          Returns MIME media type returned from format method.
 boolean supports(Metrics metrics)
          Verifies if specified metrics is supported by this formatter instance.
 

Method Detail

supports

boolean supports(Metrics metrics)
Verifies if specified metrics is supported by this formatter instance.

Parameters:
metrics - a metrics to verify
Returns:
true if metrics is supported; false otherwise

getMimeType

java.lang.String getMimeType()
Returns MIME media type returned from format method.

Returns:
supported MIME media type

format

java.lang.String format(Metrics metrics,
                        com.jscape.inet.mft.subsystems.reporting.FormatEnvironment environment)
                        throws MetricsFormatter.FormatterException
Formats the specified metrics.

Parameters:
metrics - a metrics to format
environment - an environment
Returns:
a formatted metrics data
Throws:
MetricsFormatter.FormatterException - if an error occurs

JSCAPE MFT Server

Copyright © JSCAPE LLC. 1999-2015. All Rights Reserved