AoImportTemporaryFiles (Atlassian Jira

All Known Implementing Classes:

AoImportTemporaryFilesImpl
```
public interface AoImportTemporaryFiles
```
Single interface to hold the paths to the AO XML partition files, and their temporary parent directory.

Since:

v6.5

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`File`	`createFileForEntity(String entityName)` Creates a new the file object for an entity.
`void`	`deleteTempFiles()` Deletes the temporary files held in this object.
`SortedMap<String,Long>`	`getAOEntityWeights()` Returns a map from each AOEntity to the weight used for sorting the entity.
`SortedMap<String,File>`	`getAOXmlFiles()` Returns a map from each AOEntity to the temporary XML partition file for the Entity.
`File`	`getFileForEntity(String entityName)` Returns the file registered for an entity.
`File`	`getParentDirectory()` Returns the temporary directory which is the parent of all the temporary partition files.
`void`	`registerAoEntities()` Register all the AO entities that are defined to be imported by plugins.
`void`	`registerAoXmlFile(String entityName, File file)` Record the entityName -> file mapping.

- Method Detail
  - getParentDirectory
```
File getParentDirectory()
```
    Returns the temporary directory which is the parent of all the temporary partition files.
    
    Returns:
    
    the temporary directory which is the parent of all the temporary partition files.
  - getAOXmlFiles
```
SortedMap<String,File> getAOXmlFiles()
```
    Returns a map from each AOEntity to the temporary XML partition file for the Entity. The Entities are sorted according to the weight supplied by the plugin configurations. Entities that have no import specification are sorted alphabetically to the end.
    
    Returns:
    
    the temporary XML partition files map.
  - createFileForEntity
```
File createFileForEntity(String entityName)
```
    Creates a new the file object for an entity.
    
    Parameters:
    
    entityName - The name of the entity.
    
    Returns:
    
    the temporary XML partition file.
  - getFileForEntity
```
File getFileForEntity(String entityName)
```
    Returns the file registered for an entity.
    
    Parameters:
    
    entityName - The name of the entity.
    
    Returns:
    
    the temporary XML partition file.
  - getAOEntityWeights
```
SortedMap<String,Long> getAOEntityWeights()
```
    Returns a map from each AOEntity to the weight used for sorting the entity. The Entities are sorted according to the weight supplied by the plugin configurations.
    
    Returns:
    
    the temporary XML partition file.
  - registerAoEntities
```
void registerAoEntities()
```
    Register all the AO entities that are defined to be imported by plugins. This allows us to set the correct sort order for processing the XML files later.
  - registerAoXmlFile
```
void registerAoXmlFile(String entityName,
                       File file)
```
    Record the entityName -> file mapping.
    
    Parameters:
    
    entityName - The name of the entity.
    
    file - the temporary XML partition file.
  - deleteTempFiles
```
void deleteTempFiles()
```
    Deletes the temporary files held in this object. It is safe to call this method twice as it will check if the files actually exist first.

Interface AoImportTemporaryFiles

Method Summary

Method Detail

getParentDirectory

getAOXmlFiles

createFileForEntity

getFileForEntity

getAOEntityWeights

registerAoEntities

registerAoXmlFile

deleteTempFiles