Package com.deltaxml.dita.config

Class MapParameters

java.lang.Object
com.deltaxml.dita.config.MapParameters
public class MapParameters extends Object
These parameters control how the map comparison is performed in a map topic set comparison.

  • Constructor Details

    • MapParameters

      public MapParameters()
      Creates a new MapParameters instance. These parameters control how the map comparison is performed in a map topic set comparison.

  • Method Details

    • isMapScanTopicsForReferences

      public boolean isMapScanTopicsForReferences()
      Gets the value of the mapScanTopicsForReferences parameter.
      Returns:
      the value of the mapScanTopicsForReferences parameter

    • setMapScanTopicsForReferences

      public void setMapScanTopicsForReferences(boolean value)

      Specify whether topics should be scanned when identifying a map's referenced resources (referents). It is possible for a DITA topic to directly refer to other resources rather than make use of DITA keying reuse mechanism. When this is the case, just scanning the maps for resources may not be sufficient, to identify all the resources that are referenced. Turning this option off may significantly improve the performance of the comparison, if it is known that all resources of interest are referenced directly by the maps.

      Note that this setting also affects the way in which the resources are identified when copying maps to an output directory.

      Default: true

      Parameters:
      value - the value to set for the mapScanTopicsForReferences parameter

    • getMapResultOrigin

      public MapResultOrigin getMapResultOrigin()
      Gets the value of the mapResultOrigin parameter.
      Returns:
      the value of the mapResultOrigin parameter

    • setMapResultOrigin

      public void setMapResultOrigin(MapResultOrigin value)

      When comparing the topics referenced in two maps, one of the maps is declared to be the result origin. This is the map that is used to generate the structure and/or order of topic references in the output.

      Note that the map-copy-scope parameter is used to specify what the in-scope referents are (i.e. which resources that are pointed to by the map are considered to be part of the document that the map is defining).

      Default: MapResultOrigin.B_DOCUMENT

      Parameters:
      value - the value to set for the mapResultOrigin parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapResultStructure

      public MapResultStructure getMapResultStructure()
      Gets the value of the mapResultStructure parameter.
      Returns:
      the value of the mapResultStructure parameter

    • setMapResultStructure

      public void setMapResultStructure(MapResultStructure value)

      Specifies how the result map is constructed.

      The available result structures are defined in terms of the result origin, which is the input that is being used to form the basis of the output. See the map-result-origin parameter documentation for more details.

      Default: MapResultStructure.TOPIC_SET

      Parameters:
      value - the value to set for the mapResultStructure parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapPairRemainingMapName

      public String getMapPairRemainingMapName()
      Gets the value of the mapPairRemainingMapName parameter.
      Returns:
      the value of the mapPairRemainingMapName parameter

    • setMapPairRemainingMapName

      public void setMapPairRemainingMapName(String value)

      When the map-result-structure parameter is set to map-pair, the comparison result contains two maps. An updated version of the existing origin map, and a map containing those topic references that were in the original comparison, but not in the existing origin map.

      Note that when the map-scan-topics-for-references is set to true, then the topics references within a map (and its submaps) also includes those references that are contained within the topics themselves.

      Default: "dxml-remaining.ditamap"

      Parameters:
      value - the value to set for the mapPairRemainingMapName parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapCleanTemp

      public MapCleanTemp getMapCleanTemp()
      Gets the value of the mapCleanTemp parameter.
      Returns:
      the value of the mapCleanTemp parameter

    • setMapCleanTemp

      public void setMapCleanTemp(MapCleanTemp value)

      Specifies whether to clean temporary files introduced when performing the comparison.

      During the comparison those topics that are compared are initially backed up into a file

      Default: MapCleanTemp.AUTOMATIC

      Parameters:
      value - the value to set for the mapCleanTemp parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapBackupSuffix

      public String getMapBackupSuffix()
      Gets the value of the mapBackupSuffix parameter.
      Returns:
      the value of the mapBackupSuffix parameter

    • setMapBackupSuffix

      public void setMapBackupSuffix(String value)

      When the map comparison needs to backup a file before it can be compared it appends the '.' character followed by this suffix to the existing file name. Note that if the file already exists then an IOException will be thrown.

      Default: "bak"

      Parameters:
      value - the value to set for the mapBackupSuffix parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapCopyScope

      public MapCopyScope getMapCopyScope()
      Gets the value of the mapCopyScope parameter.
      Returns:
      the value of the mapCopyScope parameter

    • setMapCopyScope

      public void setMapCopyScope(MapCopyScope value)

      Specifies how to copy a DITA map and its content to an output directory, which maintains the relative structure of the source where this is feasible.

      Some maps will contain references to resources that are both marked for copying and cannot be made relative to the map's location. In general, the resources that are referenced from a map (referents), can be grouped according to their 'host' locations, such as a specified file system, web service, version control repository, and content management system (CMS). Each of these 'host' locations is represented as a 'top-level' directory of the output directory (and thus forms a 'forest' of 'tree' structures).

      Note the output directory will also contain an additional DITA map file that includes a single reference to the copied map file. This is intended to record where the copied map is within the output directory structure, and provide a convenient point for loading the result into an DITA aware editor.

      Default: MapCopyScope.LOCAL

      Parameters:
      value - the value to set for the mapCopyScope parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapUncomparedTopicMarkup

      public MapUncomparedTopicMarkup getMapUncomparedTopicMarkup()
      Gets the value of the mapUncomparedTopicMarkup parameter.
      Returns:
      the value of the mapUncomparedTopicMarkup parameter

    • setMapUncomparedTopicMarkup

      public void setMapUncomparedTopicMarkup(MapUncomparedTopicMarkup value)

      What action to perform on topics that are not compared. Some DITA aware publishing tools do not make use of revision attributes of a topicref on the referent (i.e. the topis that is being referenced). In these cases, it can be useful to mark the top-level topic element, which is being referenced by the topicref, with appropriate revision and/or status attributes. However, for output formats that are not intended for publication, such as the editor specific tracked change formats, marking up the root element on a topic file as added or deleted, could be counter productive.

      Default: MapUncomparedTopicMarkup.AUTOMATIC

      Parameters:
      value - the value to set for the mapUncomparedTopicMarkup parameter
      Throws:
      IllegalArgumentException - if the value is null

    • getMapTopicExceptionPropagationMode

      public MapTopicExceptionPropagationMode getMapTopicExceptionPropagationMode()
      Gets the value of the mapTopicExceptionPropagationMode parameter.
      Returns:
      the value of the mapTopicExceptionPropagationMode parameter

    • setMapTopicExceptionPropagationMode

      public void setMapTopicExceptionPropagationMode(MapTopicExceptionPropagationMode value)

      What action to perform when there is an exception raised during the processing of a topic during a map file comparison.

      Default: MapTopicExceptionPropagationMode.SLOW_FAIL

      Parameters:
      value - the value to set for the mapTopicExceptionPropogationMode parameter
      Throws:
      IllegalArgumentException - if the value is null
      See Also: