Package org.odpi.openmetadata.repositoryservices.archiveutilities

Class OMRSArchiveWriter

java.lang.Object

org.odpi.openmetadata.repositoryservices.archiveutilities.OMRSArchiveWriter

Direct Known Subclasses:

BigGlossariesArchiveWriter, CloudInformationModelArchiveWriter, CocoTypesArchiveWriter, EgeriaBaseArchiveWriter, OpenMetadataTypesArchiveWriter, SimpleCatalogsArchiveWriter

public class OMRSArchiveWriter
extends Object

OMRSArchiveWriter creates physical open metadata archive files for the supplied open metadata archives encoded using Open Metadata Repository Services (OMRS) formats. To use it, create a subclass that builds the archive content in memory and then writes it out.

Constructor Summary

Constructors

Constructor	Description
OMRSArchiveWriter()	Default constructor

Method Summary

Modifier and Type	Method	Description
protected Connection	getOpenMetadataArchiveFileConnection(String fileName)	Return the connection for an open metadata archive file.
protected OpenMetadataArchive	readOpenMetadataArchive(String inputFileName)	Return the contents of an open metadata archive that has already been written, or null if there is no such file (or it cannot be read).
protected void	writeOpenMetadataArchive(String outputFileName, OpenMetadataArchive openMetadataArchive)	Generates and writes out an open metadata archive containing all the open metadata types.
protected void	writeOpenMetadataArchive(String outputFileName, OpenMetadataArchive openMetadataArchive, AuditLog auditLog)	Generates and writes out an open metadata archive containing all the open metadata types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OMRSArchiveWriter

public OMRSArchiveWriter()

Default constructor

Method Details

getOpenMetadataArchiveFileConnection

protected Connection getOpenMetadataArchiveFileConnection(String fileName)

Return the connection for an open metadata archive file.

Parameters:

fileName - name of the archive file

Returns:

OCF Connection used to create the file-based open metadata archive

readOpenMetadataArchive

protected OpenMetadataArchive readOpenMetadataArchive(String inputFileName)

Return the contents of an open metadata archive that has already been written, or null if there is no such file (or it cannot be read). This is how a writer looks at the previous edition of the archive it is about to replace.

Parameters:

inputFileName - name of the archive file to read

Returns:

archive content, or null

writeOpenMetadataArchive

protected void writeOpenMetadataArchive(String outputFileName,
 OpenMetadataArchive openMetadataArchive)

Generates and writes out an open metadata archive containing all the open metadata types.

Parameters:

outputFileName - name of file to write archive to

openMetadataArchive - archive content

writeOpenMetadataArchive

protected void writeOpenMetadataArchive(String outputFileName,
 OpenMetadataArchive openMetadataArchive,
 AuditLog auditLog)

Generates and writes out an open metadata archive containing all the open metadata types.

Parameters:

outputFileName - name of file to write archive to

openMetadataArchive - archive content

auditLog - logging destination