TextClass

• Data
  • more complex: documents/items with bibliographic header info; sometimes have page information, sometimes very highly encoded structurally, sometimes both
  • indexed with XPat
• TextClass Functionality
  • Navigation around this data / Kinds of XPat searches that give you the pieces you need to navigate around large amounts of SGML
• TextClass Middleware Components
  • text-idx, textclass.cfg
  • colldb, maps
  • SGML and XPat index
  • HTML templates
• Flowchart to show decision tree for search, filtering, etc.
• TextClass URL Parameters
  • Collection parameters: c, cc
  • Search types: type=simple | boolean | proximity
  • Pages: page=simple | boolean | simplext | booleanext
  • Query parameters: q1, q2, ..., rgn1, rgn2, ..., op2, op3, ...
  • Views: view=reslist
  • Actions: bbaction=add | remove | download | email
  • Session ID: sid=106eb945036468c97458ee38d21186a0
• Objects, modules used
  • Authorization
  • TextClass (example), TextClassUtils, CollsInfo, XPat, SearchSet (example) and XPatResultSet (example), RemoteConnect, QueryFactory and TerminologyMapper, SearchHistory, Bookbag, ProcIns, DlpsSession, DlpsUtils
  • CGI, Apache::Session
• Searching
  • Often accomplished by asking the mapper for the XPat region name and passing the CGI query object to the QueryFactory; see example TextClass::RegionTextSearches
  • Sometimes it is a simple GetSimpleXPatResults; see example TextClass::GetItemEncodingLevel
• Fabricated regions (see encoding workshop)
• Configuration
  • colldb, textclass.cfg, BookBag.cfg, DlpsSession.cfg
• PIs and HTML Templates
  • JavaScript generated by CGI to handle collection picker
• Filtering
  • general TextClass entities filtered in one routine
  • examples of interest (in TextClass.pm): NotesResultsFilter, _ScopedResultsFilter
• Subclassing
  • What do we mean by subclassing?
    • Non-OOP vs Object oriented programming
    • Classes, objects and derived classes (subclasses)
  • Why is it a Good Thing?
    • Code maintenance
    • Code Reuse
    • Runtime binding
    • Customization
  • General How To / Techniques
    • Create subclass file (Perl necessities: ISA, etc.)
    • Techniques
      • Define a method w/same name as method in Base Class to over-ride completely
      • Call SUPER:: from subclass method and add additional functionality
      • Additional functionality could include calling Base Class methods not called in Base Class method
      • Empty (abstract) Base Class method called from Base Class that does nothing unless over-riddenby subclass
      • Add to or modify Base Class Data (See CollsInfo/CITC.pm)
      • Subclass GenericTC (or other subclasses) to avoid changing any code in the release
  • Current examples
    • CollsInfo/CITC.pm: additional data + methods
    • BookBagItem/BBItemBC.pm: additional data + methods
    • Notes filtering
    • TextFilter (MqrTC)
  • Hands on:TBD
• DlpsLocalUtils / running Traps
  • Implementation
  • Example in pageviewer