com.deltaxml.mergecommon

Interface MergeCommon<DeltaXMLBaseException extends Exception,InvalidInputException extends DeltaXMLBaseException,LicenseException extends DeltaXMLBaseException,DifferentRootElementException extends DeltaXMLBaseException,DoctypeChangeException extends DeltaXMLBaseException,UnorderedDuplicateKeysException extends DeltaXMLBaseException,DifferingOrderedAttributesException extends DeltaXMLBaseException,UnorderedElementContainingPCDATAException extends DeltaXMLBaseException>

Type Parameters:

DeltaXMLBaseException - a supertype for the following generic exception parameters

InvalidInputException - a parameter for this exception used in various package

LicenseException - a parameter for this exception used in various package

DifferentRootElementException - a parameter for this exception used in various package

DoctypeChangeException - a parameter for this exception used in various package

UnorderedDuplicateKeysException - a parameter for this exception used in various package

DifferingOrderedAttributesException - a parameter for this exception used in various package

UnorderedElementContainingPCDATAException - a parameter for this exception used in various package

All Superinterfaces:

MergeBase<DeltaXMLBaseException,InvalidInputException,LicenseException,DifferentRootElementException,DoctypeChangeException,UnorderedDuplicateKeysException,DifferingOrderedAttributesException,UnorderedElementContainingPCDATAException>

All Known Implementing Classes:

ConcurrentMerge, ThreeWayMerge

public interface MergeCommon<DeltaXMLBaseException extends Exception,InvalidInputException extends DeltaXMLBaseException,LicenseException extends DeltaXMLBaseException,DifferentRootElementException extends DeltaXMLBaseException,DoctypeChangeException extends DeltaXMLBaseException,UnorderedDuplicateKeysException extends DeltaXMLBaseException,DifferingOrderedAttributesException extends DeltaXMLBaseException,UnorderedElementContainingPCDATAException extends DeltaXMLBaseException>
extends MergeBase<DeltaXMLBaseException,InvalidInputException,LicenseException,DifferentRootElementException,DoctypeChangeException,UnorderedDuplicateKeysException,DifferingOrderedAttributesException,UnorderedElementContainingPCDATAException>

A common interface for concurrent merge classes.

Method Summary

Modifier and Type	Method and Description
String	getAncestorVersion() Returns the version name of the ancestor.
void	setAncestor(File file, String version) Sets the ancestor document with a File input.
void	setAncestor(InputStream is, String systemId, String version) Sets the ancestor document with a InputStream.
void	setAncestor(Reader r, String systemId, String version) Sets the ancestor document with a Reader.
void	setAncestor(URL url, String version) Sets the ancestor document with a URL.

Methods inherited from interface com.deltaxml.mergecommon.MergeBase

addProgressListener, addVersion, addVersion, addVersion, addVersion, clearProgressListeners, extractAll, extractAll, extractAll, getCalsValidationLevel, getElementSplitting, getEntityResolver, getEntityResolver, getFormatExtractionPriorityList, getFormattingOutputType, getInvalidCalsTableBehaviour, getVersions, getWarningReportMode, getWordByWord, isProcessCalsTables, isProcessHtmlTables, removeProgressListener, reset, setCalsTableProcessing, setCalsValidationLevel, setDebug, setElementSplitting, setEntityResolver, setFormatExtractionPriorityList, setFormattingOutputType, setHtmlTableProcessing, setIndent, setInvalidCalsTableBehaviour, setLicenseFile, setLicenseServer, setLicenseServer, setRedistributionLicenseContent, setWarningReportMode, setWordByWord

Method Detail

setAncestor

void setAncestor(File file,
                 String version)
          throws IllegalStateException,
                 IllegalArgumentException,
                 FileNotFoundException,
                 InvalidInputException extends DeltaXMLBaseException,
                 UnorderedElementContainingPCDATAException extends DeltaXMLBaseException,
                 UnorderedDuplicateKeysException extends DeltaXMLBaseException,
                 LicenseException extends DeltaXMLBaseException

Sets the ancestor document with a File input.

The version parameter appears in the result file and must correspond to the NMTOKEN production rule in the XML Specification (the same production rule is used in both XML 1.0 and XML 1.1). This precludes the use of the '!' (0x21) and '=' (0x3d) characters used for version delimiting and other characters which could cause confusion such as the space character.

Parameters:

file - The input file which is the ancestor version.

version - The string to use as the name of the version. This appears in the deltaxml:deltaV2 attributes in the result. This must be an XML NMTOKEN

Throws:

FileNotFoundException - Thrown if the provided file object does not exist.

IllegalStateException - Thrown if the merge object's state is not INITIAL or RESET.

IllegalArgumentException - Thrown if the version parameter is not an NMTOKEN.

InvalidInputException - Thrown if the input is invalid in some way.

UnorderedDuplicateKeysException - Thrown if there are duplicate keys in orderless merge.

UnorderedElementContainingPCDATAException - Thrown if input contains mixed content in orderless merge.

LicenseException - Thrown if there is no license installed, or if the installed license is invalid.

InvalidInputException extends DeltaXMLBaseException

See Also:

XML 1.0 Specification, Section 2.3: Common Syntactic Constructs

setAncestor

void setAncestor(InputStream is,
                 String systemId,
                 String version)
          throws IllegalStateException,
                 IllegalArgumentException,
                 InvalidInputException extends DeltaXMLBaseException,
                 UnorderedElementContainingPCDATAException extends DeltaXMLBaseException,
                 UnorderedDuplicateKeysException extends DeltaXMLBaseException,
                 LicenseException extends DeltaXMLBaseException

Sets the ancestor document with a InputStream.

The version parameter appears in the result file and must correspond to the NMTOKEN production rule in the XML Specification (the same production rule is used in both XML 1.0 and XML 1.1). This precludes the use of the '!' (0x21) and '=' (0x3d) characters used for version delimiting and other characters which could cause confusion such as the space character.

Parameters:

is - The input steam which is the ancestor version.

systemId - The location of the ancestor input stream (for relative lookup).

version - The string to use as the name of the version. This appears in the deltaxml:deltaV2 attributes in the result. This cannot contain '=' or '!' characters.

Throws:

IllegalStateException - Thrown if the merge object's state is not INITIAL or RESET.

IllegalArgumentException - Thrown if the version parameter is not an NMTOKEN.

InvalidInputException - Thrown if the input is invalid in some way.

UnorderedDuplicateKeysException - Thrown if there are duplicate keys in orderless merge.

UnorderedElementContainingPCDATAException - Thrown if input contains mixed content in orderless merge.

LicenseException - Thrown if there is no license installed, or if the installed license is invalid.

InvalidInputException extends DeltaXMLBaseException

See Also:

XML 1.0 Specification, Section 2.3: Common Syntactic Constructs

setAncestor

void setAncestor(Reader r,
                 String systemId,
                 String version)
          throws IllegalStateException,
                 IllegalArgumentException,
                 InvalidInputException extends DeltaXMLBaseException,
                 DifferingOrderedAttributesException extends DeltaXMLBaseException,
                 UnorderedElementContainingPCDATAException extends DeltaXMLBaseException,
                 UnorderedDuplicateKeysException extends DeltaXMLBaseException,
                 LicenseException extends DeltaXMLBaseException

Sets the ancestor document with a Reader.

The version parameter appears in the result file and must correspond to the NMTOKEN production rule in the XML Specification (the same production rule is used in both XML 1.0 and XML 1.1). This precludes the use of the '!' (0x21) and '=' (0x3d) characters used for version delimiting and other characters which could cause confusion such as the space character.

Parameters:

r - The reader which is the ancestor version.

systemId - The location of the ancestor reader (for relative lookup).

version - The string to use as the name of the version. This appears in the deltaxml:deltaV2 attributes in the result. This cannot contain '=' or '!' characters.

Throws:

IllegalStateException - Thrown if the merge object's state is not INITIAL or RESET.

IllegalArgumentException - Thrown if the version parameter is not an NMTOKEN.

InvalidInputException - Thrown if the input is invalid in some way.

DifferingOrderedAttributesException - Thrown if inputs have different deltaxml:ordered attribute values.

UnorderedDuplicateKeysException - Thrown if there are duplicate keys in orderless merge.

UnorderedElementContainingPCDATAException - Thrown if input contains mixed content in orderless merge.

LicenseException - Thrown if there is no license installed, or if the installed license is invalid.

InvalidInputException extends DeltaXMLBaseException

See Also:

XML 1.0 Specification, Section 2.3: Common Syntactic Constructs

setAncestor

void setAncestor(URL url,
                 String version)
          throws IllegalStateException,
                 IllegalArgumentException,
                 IOException,
                 InvalidInputException extends DeltaXMLBaseException,
                 UnorderedElementContainingPCDATAException extends DeltaXMLBaseException,
                 UnorderedDuplicateKeysException extends DeltaXMLBaseException,
                 LicenseException extends DeltaXMLBaseException

Sets the ancestor document with a URL.

The version parameter appears in the result file and must correspond to the NMTOKEN production rule in the XML Specification (the same production rule is used in both XML 1.0 and XML 1.1). This precludes the use of the '!' (0x21) and '=' (0x3d) characters used for version delimiting and other characters which could cause confusion such as the space character.

Parameters:

url - The URL to load as the ancestor version.

version - The string to use as the name of the version. This appears in the deltaxml:deltaV2 attributes in the result. This cannot contain '=' or '!' characters.

Throws:

IOException - Thrown if a stream for the supplied URL cannot be opened.

IllegalStateException - Thrown if the merge object's state is not INITIAL or RESET.

IllegalArgumentException - Thrown if the version parameter is not an NMTOKEN.

InvalidInputException - Thrown if the input is invalid in some way.

UnorderedDuplicateKeysException - Thrown if there are duplicate keys in orderless merge.

UnorderedElementContainingPCDATAException - Thrown if input contains mixed content in orderless merge.

LicenseException - Thrown if there is no license installed, or if the installed license is invalid.

InvalidInputException extends DeltaXMLBaseException

See Also:

XML 1.0 Specification, Section 2.3: Common Syntactic Constructs

getAncestorVersion

String getAncestorVersion()

Returns the version name of the ancestor.

Returns:

the version name of the ancestor