Top Inners Fields Constructors Methods
liquibase.changelog.visitor

public Class DBDocVisitor

extends Object
implements ChangeSetVisitor
Class Inheritance
All Implemented Interfaces
liquibase.changelog.visitor.ChangeSetVisitor
Imports
liquibase.CatalogAndSchema, liquibase.change.Change, liquibase.changelog.ChangeSet, .DatabaseChangeLog, liquibase.changelog.filter.ChangeSetFilterResult, liquibase.database.Database, liquibase.database.core.FirebirdDatabase, liquibase.dbdoc.*, liquibase.exception.LiquibaseException, liquibase.resource.OpenOptions, .Resource, .ResourceAccessor, liquibase.snapshot.DatabaseSnapshot, .SnapshotControl, .SnapshotGeneratorFactory, liquibase.structure.DatabaseObject, liquibase.structure.core.Column, .Schema, .Table, liquibase.util.StreamUtil, .StringUtil, java.io.*, java.util.*, java.util.stream.Collectors

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private final SortedSet<DBDocVisitor.ChangeLogInfo>
private final Map<String, List<Change>>
private final Map<DatabaseObject, List<Change>>
private final List<Change>
private final Map<String, List<Change>>
private final Map<DatabaseObject, List<Change>>
private final Database
private static final int
private List<Change>
private DatabaseChangeLog
private String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
private void
copyFile(String fileToCopy, Resource rootOutputDir)

public ChangeSetVisitor.Direction
private boolean
private void
public void
public void
writeHTML(Resource rootOutputDir, ResourceAccessor resourceAccessor, CatalogAndSchema... schemaList)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

changeLogsback to summary
private final SortedSet<DBDocVisitor.ChangeLogInfo> changeLogs
changesByAuthorback to summary
private final Map<String, List<Change>> changesByAuthor
changesByObjectback to summary
private final Map<DatabaseObject, List<Change>> changesByObject
changesToRunback to summary
private final List<Change> changesToRun
changesToRunByAuthorback to summary
private final Map<String, List<Change>> changesToRunByAuthor
changesToRunByObjectback to summary
private final Map<DatabaseObject, List<Change>> changesToRunByObject
databaseback to summary
private final Database database
MAX_RECENT_CHANGEback to summary
private static final int MAX_RECENT_CHANGE
recentChangesback to summary
private List<Change> recentChanges
rootChangeLogback to summary
private DatabaseChangeLog rootChangeLog
rootChangeLogNameback to summary
private String rootChangeLogName

Constructor Detail

DBDocVisitorback to summary
public DBDocVisitor(Database database)

Method Detail

copyFileback to summary
private void copyFile(String fileToCopy, Resource rootOutputDir) throws IOException
getDirectionback to summary
public ChangeSetVisitor.Direction getDirection()

Implements liquibase.changelog.visitor.ChangeSetVisitor.getDirection.

Annotations
@Override
shouldNotWriteColumnHtmlback to summary
private boolean shouldNotWriteColumnHtml(Column column)
validateRequiredSchemasback to summary
private void validateRequiredSchemas(DatabaseSnapshot snapshot, CatalogAndSchema[] schemaList) throws LiquibaseException
visitback to summary
public void visit(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Database database, Set<ChangeSetFilterResult> filterResults) throws LiquibaseException

Implements liquibase.changelog.visitor.ChangeSetVisitor.visit.

Annotations
@Override
writeHTMLback to summary
public void writeHTML(Resource rootOutputDir, ResourceAccessor resourceAccessor, CatalogAndSchema... schemaList) throws IOException, LiquibaseException
liquibase.changelog.visitor back to summary

private Class DBDocVisitor.ChangeLogInfo

extends Object
implements Comparable<DBDocVisitor.ChangeLogInfo>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable

Field Summary

Modifier and TypeField and Description
public String
public String

Constructor Summary

AccessConstructor and Description
private
ChangeLogInfo(String logicalPath, String physicalPath)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(DBDocVisitor.ChangeLogInfo
the object to be compared.
o
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

logicalPathback to summary
public String logicalPath
physicalPathback to summary
public String physicalPath

Constructor Detail

ChangeLogInfoback to summary
private ChangeLogInfo(String logicalPath, String physicalPath)

Method Detail

compareToback to summary
public int compareTo(DBDocVisitor.ChangeLogInfo o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
o:DBDocVisitor.ChangeLogInfo

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override