com.adobe.idml
Class PackageXmlLocator

java.lang.Object
  extended by com.adobe.idml.PackageXmlLocator

public class PackageXmlLocator
extends java.lang.Object

Given the location of an extracted IDML Package file, this class will locate the individual XML files.


Constructor Summary
PackageXmlLocator(java.io.File expandedIdmlDir)
          Instantiates a new XMLLocator object for the expanded IDML file provided.
PackageXmlLocator(java.lang.String expandedIdmlDirPath)
          Instantiates a new XMLLocator object for the expanded IDML file provided.
 
Method Summary
 java.util.ArrayList<java.lang.String> getAllXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in an expanded IDML file.
 java.lang.String getBackingStoryFilePath()
          Returns a String with a file path to the BackingStory.xml file within an expanded IDML file.
 java.lang.String getDesignMapFilePath()
          Returns a String with a file path to the designmap.xml file within an expanded IDML file.
 java.lang.String getMasterSpreadsDirPath()
          Returns a String with a folder path to the MasterSpreads folder within an expanded IDML file.
 java.util.ArrayList<java.lang.String> getMasterSpreadXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in the MasterSpreads folder of an expanded IDML file.
 java.lang.String getMETAINFDirPath()
          Returns a String with a folder path to the META-INF folder within an expanded IDML file.
 java.util.ArrayList<java.lang.String> getMETAINFXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in the METAINF folder of an expanded IDML file.
 java.lang.String getPreferencesFilePath()
          Returns a String with a file path to the Preferences.xml file within an expanded IDML file.
 java.lang.String getResourcesDirPath()
          Returns a String with a folder path to the Resources folder within an expanded IDML file.
 java.util.ArrayList<java.lang.String> getResourcesXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in the Resources folder of an expanded IDML file.
 java.lang.String getSpreadsDirPath()
          Returns a String with a folder path to the Spreads folder within an expanded IDML file.
 java.util.ArrayList<java.lang.String> getSpreadXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in the Spreads folder of an expanded IDML file.
 java.lang.String getStoriesDirPath()
          Returns a String with a folder path to the Stories folder within an expanded IDML file.
 java.util.ArrayList<java.lang.String> getStoriesXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in the Stories folder of an expanded IDML file.
 java.lang.String getStylesFilePath()
          Returns a String with a file path to the Styles.xml file within an expanded IDML file.
 java.lang.String getTagsFilePath()
          Returns a String with a file path to the Tags.xml file within an expanded IDML file.
 java.lang.String getXMLDirPath()
          Returns a String with a folder path to the XML folder within an expanded IDML file.
 java.lang.String getXMLFile(java.lang.String dir, java.lang.String xpath)
          Returns a String containing the path to the first XML File in the designated folder that returns a result.
 java.util.ArrayList<java.lang.String> getXMLXmlFiles()
          Returns an ArrayList of Strings containing paths to all the XML Files in the XML folder of an expanded IDML file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PackageXmlLocator

public PackageXmlLocator(java.lang.String expandedIdmlDirPath)
Instantiates a new XMLLocator object for the expanded IDML file provided.

Parameters:
expandedIdmlDirPath - The path to an expanded IDML File

PackageXmlLocator

public PackageXmlLocator(java.io.File expandedIdmlDir)
Instantiates a new XMLLocator object for the expanded IDML file provided.

Parameters:
expandedIdmlDir - The file object representing the expanded IDML Directory.
Method Detail

getMasterSpreadsDirPath

public java.lang.String getMasterSpreadsDirPath()
Returns a String with a folder path to the MasterSpreads folder within an expanded IDML file.

Returns:
a String with a folder path.

getSpreadsDirPath

public java.lang.String getSpreadsDirPath()
Returns a String with a folder path to the Spreads folder within an expanded IDML file.

Returns:
a String with a folder path.

getResourcesDirPath

public java.lang.String getResourcesDirPath()
Returns a String with a folder path to the Resources folder within an expanded IDML file.

Returns:
a String with a folder path.

getStoriesDirPath

public java.lang.String getStoriesDirPath()
Returns a String with a folder path to the Stories folder within an expanded IDML file.

Returns:
a String with a folder path.

getXMLDirPath

public java.lang.String getXMLDirPath()
Returns a String with a folder path to the XML folder within an expanded IDML file.

Returns:
a String with a folder path.

getMETAINFDirPath

public java.lang.String getMETAINFDirPath()
Returns a String with a folder path to the META-INF folder within an expanded IDML file.

Returns:
a String with a folder path.

getDesignMapFilePath

public java.lang.String getDesignMapFilePath()
Returns a String with a file path to the designmap.xml file within an expanded IDML file.

Returns:
a String with a file path.

getPreferencesFilePath

public java.lang.String getPreferencesFilePath()
Returns a String with a file path to the Preferences.xml file within an expanded IDML file.

Returns:
a String with a file path.

getStylesFilePath

public java.lang.String getStylesFilePath()
Returns a String with a file path to the Styles.xml file within an expanded IDML file.

Returns:
a String with a file path.

getTagsFilePath

public java.lang.String getTagsFilePath()
Returns a String with a file path to the Tags.xml file within an expanded IDML file.

Returns:
a String with a file path.

getBackingStoryFilePath

public java.lang.String getBackingStoryFilePath()
Returns a String with a file path to the BackingStory.xml file within an expanded IDML file.

Returns:
a String with a file path.

getMETAINFXmlFiles

public java.util.ArrayList<java.lang.String> getMETAINFXmlFiles()
                                                         throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in the METAINF folder of an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException

getXMLXmlFiles

public java.util.ArrayList<java.lang.String> getXMLXmlFiles()
                                                     throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in the XML folder of an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException

getXMLFile

public java.lang.String getXMLFile(java.lang.String dir,
                                   java.lang.String xpath)
                            throws java.io.IOException,
                                   javax.xml.xpath.XPathExpressionException,
                                   PackageException
Returns a String containing the path to the first XML File in the designated folder that returns a result.

Parameters:
dir - The path the the directory.
xpath - An XPath Expression.
Returns:
an ArrayList of file paths.
Throws:
java.io.IOException
PackageException
javax.xml.xpath.XPathExpressionException

getStoriesXmlFiles

public java.util.ArrayList<java.lang.String> getStoriesXmlFiles()
                                                         throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in the Stories folder of an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException

getResourcesXmlFiles

public java.util.ArrayList<java.lang.String> getResourcesXmlFiles()
                                                           throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in the Resources folder of an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException

getSpreadXmlFiles

public java.util.ArrayList<java.lang.String> getSpreadXmlFiles()
                                                        throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in the Spreads folder of an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException

getMasterSpreadXmlFiles

public java.util.ArrayList<java.lang.String> getMasterSpreadXmlFiles()
                                                              throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in the MasterSpreads folder of an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException

getAllXmlFiles

public java.util.ArrayList<java.lang.String> getAllXmlFiles()
                                                     throws java.io.IOException
Returns an ArrayList of Strings containing paths to all the XML Files in an expanded IDML file.

Returns:
an ArrayList of file paths.
Throws:
java.io.IOException


Copyright © 2008 Adobe Systems Incorporated. All Rights Reserved.