com.gisgraphy.importer

## Class GeonamesAlternateNamesSimpleImporter

- java.lang.Object
- - com.gisgraphy.importer.AbstractSimpleImporterProcessor
  - - com.gisgraphy.importer.GeonamesAlternateNamesSimpleImporter

- All Implemented Interfaces:
    IImporterProcessor
  Direct Known Subclasses:
    GeonamesAlternateNamesAdmImporter

      public class GeonamesAlternateNamesSimpleImporter
      extends AbstractSimpleImporterProcessor

  Import the Alternate names.
  Author:
    David Masclet

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected IAdmDao` | `admDao`
    `protected IAlternateNameDao` | `alternateNameDao`
    `protected ICityDao` | `cityDao`
    `protected IGisFeatureDao` | `gisFeatureDao`
    `protected static org.slf4j.Logger` | `logger`
    `protected ISolRSynchroniser` | `solRSynchroniser`
    `protected ISpellCheckerIndexer` | `spellCheckerIndexer`

    - ### Fields inherited from class com.gisgraphy.importer.AbstractSimpleImporterProcessor

      `COMMENT_START, currentFile, importerConfig, in, internationalisationService, readFileLine, status, statusMessage, totalReadLine, transactionManager, txDefinition, txStatus`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `GeonamesAlternateNamesSimpleImporter()` Default constructor

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `flushAndClear()` Should flush and clear all the Daos that are used by the processor.
    `protected File[]` | `getFiles()`
    `protected int` | `getNumberOfColumns()`
    `protected void` | `processData(String line)` Process a read line of the geonames file, must be implemented by the concrete class
    `List<NameValueDTO<Integer>>` | `rollback()` /!
    `void` | `setAdmDao(IAdmDao admDao)`
    `void` | `setAlternateNameDao(IAlternateNameDao alternateNameDao)`
    `void` | `setCityDao(ICityDao cityDao)`
    `protected void` | `setCommitFlushMode()` Will flush after every commit
    `void` | `setGisFeatureDao(IGisFeatureDao gisFeatureDao)`
    `void` | `setSolRSynchroniser(ISolRSynchroniser solRSynchroniser)`
    `void` | `setSpellCheckerIndexer(ISpellCheckerIndexer spellCheckerIndexer)`
    `boolean` | `shouldBeSkipped()`
    `protected boolean` | `shouldIgnoreComments()` Whether the filter should ignore the comments (i.e. lines starting with #)
    `protected boolean` | `shouldIgnoreFirstLine()` Template Method : Whether the processor should ignore the first line of the input
    `protected void` | `tearDown()` Template method that can be override.

    - ### Methods inherited from class com.gisgraphy.importer.AbstractSimpleImporterProcessor

      `checkNumberOfColumn, commit, countLines, decrementReadedFileLine, dumpFields, getCurrentFileName, getMaxInsertsBeforeFlush, getNumberOfLinesToProcess, getReadFileLine, getStatus, getStatusMessage, getTotalReadLine, incrementReadedFileLine, isEmptyField, isEndOfDocument, needCommit, onFileProcessed, process, processError, readLineAndProcessData, resetStatus, rollbackTransaction, setImporterConfig, setInternationalisationService, setTransactionManager, setup, startTransaction`

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

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

- - ### Field Detail

    - #### logger

          protected static final org.slf4j.Logger logger

    - #### gisFeatureDao

          protected IGisFeatureDao gisFeatureDao

    - #### cityDao

          protected ICityDao cityDao

    - #### admDao

          protected IAdmDao admDao

    - #### alternateNameDao

          protected IAlternateNameDao alternateNameDao

    - #### solRSynchroniser

          protected ISolRSynchroniser solRSynchroniser

    - #### spellCheckerIndexer

          protected ISpellCheckerIndexer spellCheckerIndexer

  - ### Constructor Detail

    - #### GeonamesAlternateNamesSimpleImporter

          public GeonamesAlternateNamesSimpleImporter()

      Default constructor

  - ### Method Detail

    - #### processData

          protected void processData(String line)

      Description copied from class: `AbstractSimpleImporterProcessor`
      Process a read line of the geonames file, must be implemented by the concrete class
      Specified by:
        `processData` in class `AbstractSimpleImporterProcessor`
      Parameters:
        `line` - the line to process

    - #### shouldIgnoreFirstLine

          protected boolean shouldIgnoreFirstLine()

      Description copied from class: `AbstractSimpleImporterProcessor`
      Template Method : Whether the processor should ignore the first line of the input
      Specified by:
        `shouldIgnoreFirstLine` in class `AbstractSimpleImporterProcessor`
      Returns:
        true if the processor should ignore first line

    - #### shouldIgnoreComments

          protected boolean shouldIgnoreComments()

      Description copied from class: `AbstractSimpleImporterProcessor`
      Whether the filter should ignore the comments (i.e. lines starting with #)
      Specified by:
        `shouldIgnoreComments` in class `AbstractSimpleImporterProcessor`
      See Also:
        `AbstractSimpleImporterProcessor.COMMENT_START`

    - #### setCommitFlushMode

          protected void setCommitFlushMode()

      Description copied from class: `AbstractSimpleImporterProcessor`
      Will flush after every commit
      Specified by:
        `setCommitFlushMode` in class `AbstractSimpleImporterProcessor`
      See Also:
        `AbstractSimpleImporterProcessor.flushAndClear()`

    - #### flushAndClear

          protected void flushAndClear()

      Description copied from class: `AbstractSimpleImporterProcessor`
      Should flush and clear all the Daos that are used by the processor. This avoid memory leak
      Specified by:
        `flushAndClear` in class `AbstractSimpleImporterProcessor`

    - #### getNumberOfColumns

          protected int getNumberOfColumns()

      Specified by:
        `getNumberOfColumns` in class `AbstractSimpleImporterProcessor`
      Returns:
        the number of fields the processed Geonames file should have

    - #### tearDown

          protected void tearDown()

      Description copied from class: `AbstractSimpleImporterProcessor`
      Template method that can be override. This method is called after the end of the process. it is not called for each file processed. You should always call super.tearDown() when you overide this method
      Overrides:
        `tearDown` in class `AbstractSimpleImporterProcessor`

    - #### setAlternateNameDao

          public void setAlternateNameDao(IAlternateNameDao alternateNameDao)

      Parameters:
        `alternateNameDao` - The alternateDao to set

    - #### setGisFeatureDao

          public void setGisFeatureDao(IGisFeatureDao gisFeatureDao)

      Parameters:
        `gisFeatureDao` - The GisFeatureDao to set

    - #### setCityDao

          public void setCityDao(ICityDao cityDao)

      Parameters:
        `cityDao` - The cityDao to set

    - #### setAdmDao

          public void setAdmDao(IAdmDao admDao)

      Parameters:
        `admDao` - the admDao to set

    - #### shouldBeSkipped

          public boolean shouldBeSkipped()

      Specified by:
        `shouldBeSkipped` in interface `IImporterProcessor`
      Overrides:
        `shouldBeSkipped` in class `AbstractSimpleImporterProcessor`
      Returns:
        true if the processor should Not be executed

    - #### getFiles

          protected File[] getFiles()

      Specified by:
        `getFiles` in class `AbstractSimpleImporterProcessor`
      Returns:
        The files to be process
      See Also:
        `ImporterHelper`

    - #### setSolRSynchroniser

          public void setSolRSynchroniser(ISolRSynchroniser solRSynchroniser)

      Parameters:
        `solRSynchroniser` - the solRSynchroniser to set

    - #### setSpellCheckerIndexer

          public void setSpellCheckerIndexer(ISpellCheckerIndexer spellCheckerIndexer)

      Parameters:
        `spellCheckerIndexer` - the spellCheckerIndexer to set

    - #### rollback

          public List<NameValueDTO<Integer>> rollback()

      Description copied from interface: `IImporterProcessor`
      /!\ USE THIS METHOD VERY CAREFULLY /!\ : If you call this function, all the imported data for the specified importer will be deleted
      Returns:
        a NameValueDTO with the name of the deleted object and the number of deleted Object. No entry will be return for Object that were 0 object will be deleted except if an error occurred during the deletion.

Copyright © 2015. All rights reserved.