Docmosis API 4.5.0

com.docmosis.template
Class TemplateDetails

java.lang.Object
  extended bycom.docmosis.template.store.TemplateIdentifier
      extended bycom.docmosis.template.TemplateDetails

public class TemplateDetails
extends TemplateIdentifier

A simple holder of details for a template.

See Also:
TemplateDetails

Constructor Summary
TemplateDetails(TemplateIdentifier templateId, long origSize, long origLastModified, long workingSize, long workingLastModified, TemplateAnalysis analysis, File thumbNail)
          Construct a new template details object with the given information
 
Method Summary
 boolean equals(Object comparedObject)
          Test for equality.
 TemplateAnalysis getAnalysis()
          Get the analysis for this template.
 long getLastModified()
          Get the time (in milliseconds since the epoch) since this template was last updated.
 long getOriginalLastModified()
          Get the time (in milliseconds since the epoch) since the original template was last updated.
 long getOriginalSize()
          Get the size of original of this template.
 long getSize()
          Get the size of this template.
 File getThumbnail()
          Get an File handle over the thumbnail for image for this template.
 int hashCode()
           
 String toString()
           
 
Methods inherited from class com.docmosis.template.store.TemplateIdentifier
createUniqueTempTemplateIdentifier, fromPath, getContext, getFullPath, getName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TemplateDetails

public TemplateDetails(TemplateIdentifier templateId,
                       long origSize,
                       long origLastModified,
                       long workingSize,
                       long workingLastModified,
                       TemplateAnalysis analysis,
                       File thumbNail)
Construct a new template details object with the given information

Parameters:
templateId - the id for the template
origSize - the size of the original
origLastModified - the last time the original was modified
workingSize - the size of the working template
workingLastModified - the last time the working template was modified
analysis - the analysis of the template
thumbNail - the thumbnail image of the template.
Method Detail

getSize

public long getSize()
Get the size of this template.

Returns:
-1 if not known.

getLastModified

public long getLastModified()
Get the time (in milliseconds since the epoch) since this template was last updated.

Returns:
-1 if not known.

getOriginalSize

public long getOriginalSize()
Get the size of original of this template.

Returns:
-1 if not known.

getOriginalLastModified

public long getOriginalLastModified()
Get the time (in milliseconds since the epoch) since the original template was last updated.

Returns:
-1 if not known.

getAnalysis

public TemplateAnalysis getAnalysis()
Get the analysis for this template.

Returns:
null if not available

getThumbnail

public File getThumbnail()
Get an File handle over the thumbnail for image for this template.

Returns:
null if no thumbnail exists or if it cannot be obtained as a local file.

toString

public String toString()
Overrides:
toString in class TemplateIdentifier

equals

public boolean equals(Object comparedObject)
Test for equality.

Overrides:
equals in class TemplateIdentifier

hashCode

public int hashCode()
Overrides:
hashCode in class TemplateIdentifier

Docmosis API 4.5.0

Copyright © 2014 Docmosis Pty Ltd. All Rights Reserved.