Table of Contents

Oracle Outside In Search Export Developer's Guide

• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
  • Related Documents
  • Conventions
• Part I Getting Started with Search Export
  • 1 Introduction
    • 1.1 What's New in This Release
    • 1.2 What Does This Technology Do?
      • 1.2.1 SearchML
      • 1.2.2 PageML
      • 1.2.3 SearchHTML
      • 1.2.4 SearchText
    • 1.3 Architectural Overview
    • 1.4 Definition of Terms
    • 1.5 Directory Structure
      • 1.5.1 Installing Multiple SDKs
    • 1.6 How to Use Search Export
    • 1.7 Copyright Information
    • 1.8 Oracle Outside In Search Export Licensing
  • 2 Implementation Issues
    • 2.1 Running in 24x7 Environments
    • 2.2 Running in Multiple Threads or Processes
  • 3 Sample Applications
    • 3.1 Building the Samples on a Windows System
    • 3.2 An Overview of the Sample Applications
      • 3.2.1 *sample
      • 3.2.2 batch_process_sx
      • 3.2.3 export (Windows Only)
      • 3.2.4 exsimple
      • 3.2.5 extract_archive
      • 3.2.6 process_isolate
      • 3.2.7 xxredir (Search Export)
    • 3.3 Accessing the SDK via a Java Wrapper
      • 3.3.1 The ExJava Wrapper API
      • 3.3.2 The C-Based Exporter Application
      • 3.3.3 Compiling the Executables
      • 3.3.4 The ExportTest Sample Application
      • 3.3.5 An Example Conversion Using the ExJava Wrapper
• Part II Using the C/C++ API
  • 4 Windows Implementation Details
    • 4.1 Installation
      • 4.1.1 NSF Support
    • 4.2 Libraries and Structure
      • 4.2.1 API DLLs
      • 4.2.2 Support DLLs
      • 4.2.3 Engine Libraries
      • 4.2.4 Filter and Export Filter Libraries
      • 4.2.5 Premier Graphics Filters
      • 4.2.6 Additional Files
    • 4.3 The Basics
      • 4.3.1 What You Need in Your Source Code
      • 4.3.2 Options and Information Storage
      • 4.3.3 Structure Alignment
      • 4.3.4 Character Sets
      • 4.3.5 Runtime Considerations
    • 4.4 Default Font Aliases
    • 4.5 Changing Resources
  • 5 UNIX Implementation Details
    • 5.1 Installation
      • 5.1.1 NSF Support
    • 5.2 Libraries and Structure
      • 5.2.1 API Libraries
      • 5.2.2 Support Libraries
      • 5.2.3 Engine Libraries
      • 5.2.4 Filter and Export Filter Libraries
      • 5.2.5 Premier Graphics Filters
      • 5.2.6 Additional Files
    • 5.3 The Basics
      • 5.3.1 What You Need in Your Source Code
      • 5.3.2 Information Storage
    • 5.4 Character Sets
    • 5.5 Runtime Considerations
      • 5.5.1 X Server Requirement
      • 5.5.2 OLE2 Objects
      • 5.5.3 Signal Handling
      • 5.5.4 Runtime Search Path and $ORIGIN
    • 5.6 Environment Variables
    • 5.7 Changing Resources
    • 5.8 HP-UX Compiling and Linking
      • 5.8.1 HP-UX on RISC
      • 5.8.2 HP-UX on RISC (64 bit)
      • 5.8.3 HP-UX on Itanium (64 bit)
    • 5.9 IBM AIX Compiling and Linking
      • 5.9.1 IBM AIX (32-bit pSeries)
      • 5.9.2 IBM AIX PPC (64-bit)
    • 5.10 Linux Compiling and Linking
      • 5.10.1 Library Compatibility
      • 5.10.2 Compiling and Linking
    • 5.11 Oracle Solaris Compiling and Linking
      • 5.11.1 Oracle Solaris SPARC
      • 5.11.2 Oracle Solaris (SPARC) 64
      • 5.11.3 Oracle Solaris x86
    • 5.12 z/OS Compiling and Linking
  • 6 Data Access Common Functions
    • 6.1 Deprecated Functions
    • 6.2 DAInitEx
    • 6.3 DADeInit
    • 6.4 DAOpenDocument
      • 6.4.1 IOSPECLINKEDOBJECT Structure
      • 6.4.2 IOSPECARCHIVEOBJECT Structure
      • 6.4.3 SCCDAOBJECT Structure
    • 6.5 DACloseDocument
    • 6.6 DARetrieveDocHandle
    • 6.7 DASetOption
    • 6.8 DAGetOption
    • 6.9 DAGetFileId
    • 6.10 DAGetFileIdEx
    • 6.11 DAGetErrorString
    • 6.12 DAGetObjectInfo
    • 6.13 DAGetTreeCount
    • 6.14 DAGetTreeRecord
      • 6.14.1 SCCDATREENODE Structure
    • 6.15 DAOpenTreeRecord
    • 6.16 DAOpenRandomTreeRecord
      • 6.16.1 DATREENODELOCATOR
      • 6.16.2 SCCCA_TREENODELOCATOR: Tree Node Locator
    • 6.17 DASaveInputObject
    • 6.18 DASaveTreeRecord
    • 6.19 DASaveRandomTreeRecord
      • 6.19.1 DATREENODELOCATOR
      • 6.19.2 SCCCA_TREENODELOCATOR: Tree Node Locator
    • 6.20 DACloseTreeRecord
    • 6.21 DASetStatCallback
    • 6.22 DASetFileAccessCallback
  • 7 Export Functions
    • 7.1 General Functions
      • 7.1.1 EXOpenExport
      • 7.1.2 EXCloseExport
      • 7.1.3 EXRunExport
      • 7.1.4 EXExportStatus
  • 8 Redirected IO
    • 8.1 Using Redirected IO
    • 8.2 Opening Files
    • 8.3 IOClose
    • 8.4 IORead
    • 8.5 IOWrite
    • 8.6 IOSeek
    • 8.7 IOTell
    • 8.8 IOGetInfo
      • 8.8.1 IOGENSECONDARY and IOGENSECONDARYW Structures
      • 8.8.2 File Types That Cause IOGETINFO_GENSECONDARY
    • 8.9 IOSEEK64PROC / IOTELL64PROC
      • 8.9.1 IOSeek64
      • 8.9.2 IOTell64
  • 9 Search Export Options
    • 9.1 Search Export C/C++ Options
      • 9.1.1 Character Mapping
      • 9.1.2 Output
      • 9.1.3 Input Handling
      • 9.1.4 Compression
      • 9.1.5 XML
      • 9.1.6 File System
• Part III Using the Java API
  • 10 Introduction to the Java API
    • 10.1 Requirements
    • 10.2 Getting Started
      • 10.2.1 Configure the Environment
      • 10.2.2 Generate Code
  • 11 Search Export Java Classes
    • 11.1 Exporter Interface
      • 11.1.1 Document Interface
      • 11.1.2 OptionsCache Class
    • 11.2 ExportStatus Class
    • 11.3 FileFormat Class
    • 11.4 ObjectInfo Class
    • 11.5 OutsideIn
    • 11.6 OutsideInException Class
    • 11.7 TreeRecord Class
    • 11.8 XMLReference Class
• Part IV Using the .NET API
  • 12 Introduction to the .NET API
    • 12.1 Requirements
    • 12.2 Getting Started
      • 12.2.1 Configuring your Environment
      • 12.2.2 Generate Code
  • 13 Search Export .NET Classes
    • 13.1 Exporter Interface
      • 13.1.1 Document Interface
      • 13.1.2 OptionsCache Class
    • 13.2 ExportStatus Class
    • 13.3 FileFormat Class
    • 13.4 ObjectInfo Class
    • 13.5 OutsideIn Class
    • 13.6 OutsideInException Class
    • 13.7 TreeRecord Class
    • 13.8 XMLReference Class