| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectedu.harvard.hul.ois.jhove.module.pdf.PdfProfile
public abstract class PdfProfile
Abstract class for PDF profile checkers.
| Field Summary | |
|---|---|
| protected  PdfModule | _moduleThe module invoking this profile. | 
| protected  Parser | _parserThe Parser being used on the file. | 
| protected  java.lang.String | _profileTextA brief human-readable description of the profile. | 
| protected  java.io.RandomAccessFile | _rafThe file being analyzed. | 
| Constructor Summary | |
|---|---|
| PdfProfile(PdfModule module)Creates a PdfProfile. | |
| Method Summary | |
|---|---|
|  java.lang.String | getText()Returns the text which describes this profile. | 
| protected  boolean | hasFilters(PdfObject filter,
           java.lang.String[] names)Returns trueif a Filter object contains a filter name which
  matches any of the Strings in the second argument. | 
|  boolean | isAlreadyOK()Returns the value of the alreadyOK flag. | 
|  boolean | satisfiesProfile(java.io.RandomAccessFile raf,
                 Parser parser)Returns trueif the document satisfies the profile. | 
| abstract  boolean | satisfiesThisProfile()Returns trueif the document satisfies the
 profile. | 
| protected  boolean | xObjectOK(PdfDictionary xo)Checks a single XObject for xObjectsOK. | 
| protected  boolean | xObjectsOK(PdfDictionary xos)This checks the "XObjects" dictionary, which is a dictionary whose entries have values that are XObjects. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
protected PdfModule _module
protected java.lang.String _profileText
protected Parser _parser
protected java.io.RandomAccessFile _raf
| Constructor Detail | 
|---|
public PdfProfile(PdfModule module)
module - The PDFModule we're working under| Method Detail | 
|---|
public boolean isAlreadyOK()
true.
public final boolean satisfiesProfile(java.io.RandomAccessFile raf,
                                      Parser parser)
true if the document satisfies the profile.
 This calls satisfiesThisProfile(), which does the actual work.
raf - The RandomAccessFile being parsedparser - The Parser being used on the filepublic abstract boolean satisfiesThisProfile()
true if the document satisfies the
 profile.  Subclasses should override satisfiesThisProfile(),
 not satisfiesProfile(), as
 satisfiesProfile() does some
 additional bookkeeping for all subclases.
public java.lang.String getText()
protected boolean hasFilters(PdfObject filter,
                             java.lang.String[] names)
true if a Filter object contains a filter name which
  matches any of the Strings in the second argument.  
  Will return false if a PdfException is thrown due 
  to an unexpected data type.
 
  (Note 24-Feb-04:  This was returning false if any filter matched,
   but that's contrary to both the sense conveyed by the name and
   the way it's being called.  Was there a reason it was that way?)
filter - A PdfObject which may be either a PdfSimpleObject
                  encapsulating a Name, or a PdfArray of such objects.
                  If a null value is passed, it doesn't match any filter,
                  so false is returned.names - An array of Strings naming the filters which should
                  precipitate a true resultprotected boolean xObjectsOK(PdfDictionary xos)
protected boolean xObjectOK(PdfDictionary xo)
true.
  Override to implement tests.
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||