org.apache.poi.ss.extractor

## Class EmbeddedExtractor

- java.lang.Object
- - org.apache.poi.ss.extractor.EmbeddedExtractor

- All Implemented Interfaces:
    java.lang.Iterable<EmbeddedExtractor>
  Direct Known Subclasses:
    EmbeddedExtractor.Ole10Extractor

      @Beta
      public class EmbeddedExtractor
      extends java.lang.Object
      implements java.lang.Iterable<EmbeddedExtractor>

  This extractor class tries to identify various embedded documents within Excel files and provide them via a common interface, i.e. the EmbeddedData instances

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `EmbeddedExtractor.Ole10Extractor`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `EmbeddedExtractor()`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `canExtract(DirectoryNode source)`
    `boolean` | `canExtract(Picture source)`
    `protected static void` | `copyNodes(DirectoryNode src, DirectoryNode dest)`
    `protected EmbeddedData` | `extract(DirectoryNode dn)`
    `protected EmbeddedData` | `extract(Picture source)`
    `protected void` | `extractAll(ShapeContainer<?> parent, java.util.List<EmbeddedData> embeddings)`
    `java.util.List<EmbeddedData>` | `extractAll(Sheet sheet)`
    `EmbeddedData` | `extractOne(DirectoryNode src)`
    `EmbeddedData` | `extractOne(Picture src)`
    `java.util.Iterator<EmbeddedExtractor>` | `iterator()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface java.lang.Iterable

      `forEach, spliterator`

- - ### Constructor Detail

    - #### EmbeddedExtractor

          public EmbeddedExtractor()

  - ### Method Detail

    - #### iterator

          public java.util.Iterator<EmbeddedExtractor> iterator()

      Specified by:
        `iterator` in interface `java.lang.Iterable<EmbeddedExtractor>`
      Returns:
        the list of known extractors, if you provide custom extractors, override this method

    - #### extractOne

          public EmbeddedData extractOne(DirectoryNode src)
                                  throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### extractOne

          public EmbeddedData extractOne(Picture src)
                                  throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### extractAll

          public java.util.List<EmbeddedData> extractAll(Sheet sheet)
                                                  throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### extractAll

          protected void extractAll(ShapeContainer<?> parent,
                                    java.util.List<EmbeddedData> embeddings)
                             throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### canExtract

          public boolean canExtract(DirectoryNode source)

    - #### canExtract

          public boolean canExtract(Picture source)

    - #### extract

          protected EmbeddedData extract(DirectoryNode dn)
                                  throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### extract

          protected EmbeddedData extract(Picture source)
                                  throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### copyNodes

          protected static void copyNodes(DirectoryNode src,
                                          DirectoryNode dest)
                                   throws java.io.IOException

      Throws:
        `java.io.IOException`

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.