com.aquafold.openapi.compare
Interface AQSchemaDifferences

public interface AQSchemaDifferences

This interface represents results of schema comparison.

Method Summary

void	addSortingByNameAscending() Adds sorting by schema object name in ascending order.
void	addSortingByNameDescending() Adds sorting by schema object name in descending order.
void	addSortingByResultAscending() Adds sorting by comparison result in ascending order (deleted, modified, added, unchanged).
void	addSortingByResultDescending() Adds sorting by comparison result in descending order (unchanged, added, modified, deleted).
void	addSortingByTypeAscending() Adds sorting by schema object type in ascending order.
void	addSortingByTypeDescending() Adds sorting by schema object type in descending order.
void	clearSorting() Removes all sorting criteria.
AQSchemaCompareItem[]	getAddedItems() Returns an array of added items.
AQCompareOptions	getCompareOptions() Returns a mutable object which allows for setting comparison options.
AQSchemaCompareItem[]	getDeletedItems() Returns an array of deleted items.
AQSchemaCompareItem[]	getModifiedItems() Returns an array of modified items.
AQSchemaCompareItem[]	getUnchangedItems() Returns an array of unchanged items.
boolean	hasChanges() Returns true if there is at least one difference.
void	saveToHtml(String folderName) Generates a set of HTML files representing the differences.
void	saveToHtml(String folderName, boolean includeAdded, boolean includeModified, boolean includeDeleted, boolean includeUnchanged) Generates a set of HTML files representing the differences.
void	sort() Sorts the result using criteria set with addSorting...

Method Detail

addSortingByTypeAscending

void addSortingByTypeAscending()

Adds sorting by schema object type in ascending order. This method performs no sorting, call sort() to actually sort the data.

addSortingByTypeDescending

void addSortingByTypeDescending()

Adds sorting by schema object type in descending order. This method performs no sorting, call sort() to actually sort the data.

addSortingByNameAscending

void addSortingByNameAscending()

Adds sorting by schema object name in ascending order. This method performs no sorting, call sort() to actually sort the data.

addSortingByNameDescending

void addSortingByNameDescending()

Adds sorting by schema object name in descending order. This method performs no sorting, call sort() to actually sort the data.

addSortingByResultAscending

void addSortingByResultAscending()

Adds sorting by comparison result in ascending order (deleted, modified, added, unchanged). This method performs no sorting, call sort() to actually sort the data.

addSortingByResultDescending

void addSortingByResultDescending()

Adds sorting by comparison result in descending order (unchanged, added, modified, deleted). This method performs no sorting, call sort() to actually sort the data.

clearSorting

void clearSorting()

Removes all sorting criteria. This method performs no sorting, call sort() to actually sort the data.

sort

void sort()

Sorts the result using criteria set with addSorting... methods.

hasChanges

boolean hasChanges()

Returns true if there is at least one difference.

saveToHtml

void saveToHtml(String folderName)
                throws Exception

Generates a set of HTML files representing the differences.

Parameters:

folderName - Output folder name.

Throws:

Exception

saveToHtml

void saveToHtml(String folderName,
                boolean includeAdded,
                boolean includeModified,
                boolean includeDeleted,
                boolean includeUnchanged)
                throws Exception

Generates a set of HTML files representing the differences. This method allows to selectively include or exclude certain items.

Parameters:

folderName - Output folder name.

includeAdded -

includeModified -

includeDeleted -

includeUnchanged -

Throws:

Exception

getAddedItems

AQSchemaCompareItem[] getAddedItems()

Returns an array of added items.

getDeletedItems

AQSchemaCompareItem[] getDeletedItems()

Returns an array of deleted items.

getModifiedItems

AQSchemaCompareItem[] getModifiedItems()

Returns an array of modified items.

getUnchangedItems

AQSchemaCompareItem[] getUnchangedItems()

Returns an array of unchanged items.

getCompareOptions

AQCompareOptions getCompareOptions()

Returns a mutable object which allows for setting comparison options. These options are initially inherited from the parent compare operation.