com.revolsys.io.saif

Class SaifWriter

java.lang.Object

com.revolsys.io.AbstractObjectWithProperties

com.revolsys.io.AbstractWriter<Record>

com.revolsys.io.AbstractRecordWriter

com.revolsys.io.saif.SaifWriter

All Implemented Interfaces:

ObjectWithProperties, Writer<Record>, AutoCloseable

public class SaifWriter
extends AbstractRecordWriter

The SaifWriter.

Author:

Paul Austin

See Also:

SaifReader

Field Summary

Fields

Modifier and Type	Field and Description
protected OsnConverterRegistry	converters

Constructor Summary

Constructors

Constructor and Description
SaifWriter()
SaifWriter(File file)
SaifWriter(File file, RecordDefinitionFactory recordDefinitionFactory)
SaifWriter(String fileName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompositeTypeName(String typePath, String compositeTypeName)
protected void	addExport(String typePath, String compositeType, String objectSubset)
void	close()
protected OsnSerializer	createSerializer(String typePath, File file, long maxSize)
void	flush()
File	getFile()
int	getMaxSubsetSize()
String	getObjectIdentifier(String typePath)
Map<String,String>	getObjectIdentifiers()
String	getObjectSetName(String typePath) Get the object set name (file name) within a SAIF archive file name for the specified type name.
Map<String,String>	getObjectSetNames()
String	getSchemaResource()
File	getTempDirectory()
boolean	isIndentEnabled()
void	setCompositeTypeNames(Map<String,String> compositeTypeNames)
void	setFile(File file)
void	setIndentEnabled(boolean indentEnabled)
void	setMaxSubsetSize(int maxSubsetSize)
void	setObjectIdentifiers(Map<String,String> objectIdentifiers)
void	setObjectSetName(String typePath, String subSetName) Set the full object set name (file name) within a SAIF archive file name for the specified type name.
void	setObjectSetNames(Map<String,String> objectSetNames)
void	setRecordDefinitionFactory(RecordDefinitionFactory schema)
void	setSchemaFileNames(List<org.springframework.core.io.Resource> schemaFileNames)
void	setSchemaResource(String schemaResource)
String	toString()
void	write(Record object)
void	writeExport(OsnSerializer exportsSerializer, String referenceId, String compositeTypeName, String objectSubset)

Methods inherited from class com.revolsys.io.AbstractRecordWriter

getRecordDefinition, isIndent, isWritable, isWriteNulls, setIndent, setProperty, setWriteNulls

Methods inherited from class com.revolsys.io.AbstractWriter

close, close, close, open

Methods inherited from class com.revolsys.io.AbstractObjectWithProperties

clearProperties, getProperties, getProperty, getProperty, removeProperty, setProperties, setPropertySoft, setPropertyWeak

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.revolsys.io.ObjectWithProperties

clearProperties, getProperties, getProperty, getProperty, removeProperty, setProperties, setPropertySoft, setPropertyWeak

Field Detail

converters

protected OsnConverterRegistry converters

Constructor Detail

SaifWriter

public SaifWriter()

SaifWriter

public SaifWriter(File file)
           throws IOException

Throws:

IOException

SaifWriter

public SaifWriter(File file,
          RecordDefinitionFactory recordDefinitionFactory)
           throws IOException

Throws:

IOException

SaifWriter

public SaifWriter(String fileName)
           throws IOException

Throws:

IOException

Method Detail

addCompositeTypeName

public void addCompositeTypeName(String typePath,
                        String compositeTypeName)

addExport

protected void addExport(String typePath,
             String compositeType,
             String objectSubset)

close

public void close()

Specified by:

close in interface Writer<Record>

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractWriter<Record>

createSerializer

protected OsnSerializer createSerializer(String typePath,
                             File file,
                             long maxSize)
                                  throws IOException

Throws:

IOException

flush

public void flush()

Specified by:

flush in interface Writer<Record>

Overrides:

flush in class AbstractWriter<Record>

getFile

public File getFile()

getMaxSubsetSize

public int getMaxSubsetSize()

getObjectIdentifier

public String getObjectIdentifier(String typePath)

getObjectIdentifiers

public Map<String,String> getObjectIdentifiers()

Returns:

the objectIdentifiers

getObjectSetName

public String getObjectSetName(String typePath)

Get the object set name (file name) within a SAIF archive file name for the specified type name. The null value will be returned if a object set name has not been set for that type name.

Parameters:

typePath - The type name.

Returns:

The object set name for the type name.

getObjectSetNames

public Map<String,String> getObjectSetNames()

getSchemaResource

public String getSchemaResource()

getTempDirectory

public File getTempDirectory()

isIndentEnabled

public boolean isIndentEnabled()

setCompositeTypeNames

public void setCompositeTypeNames(Map<String,String> compositeTypeNames)

setFile

public void setFile(File file)
             throws IOException

Throws:

IOException

setIndentEnabled

public void setIndentEnabled(boolean indentEnabled)

setMaxSubsetSize

public void setMaxSubsetSize(int maxSubsetSize)

setObjectIdentifiers

public void setObjectIdentifiers(Map<String,String> objectIdentifiers)

Parameters:

objectIdentifiers - the objectIdentifiers to set

setObjectSetName

public void setObjectSetName(String typePath,
                    String subSetName)

Set the full object set name (file name) within a SAIF archive file name for the specified type name. The name must include the .osn (or other) extension (e.g. globmeta.osn). If the file is to be split into multiple object sub sets (for large files) include {$partNum} before the file extension (e.g. roads{$segment}.osn) and the file names will include the object sub set number. If a value is not set the file name will be the first 6 characters of the type name, followed by a object subset number starting at 00 with the .osn suffix (e.g. BreakLines would be breakl00.osn).

Parameters:

typePath - The type name

subSetName - The sub set name for the type name.

setObjectSetNames

public void setObjectSetNames(Map<String,String> objectSetNames)

setRecordDefinitionFactory

public void setRecordDefinitionFactory(RecordDefinitionFactory schema)

setSchemaFileNames

public void setSchemaFileNames(List<org.springframework.core.io.Resource> schemaFileNames)

setSchemaResource

public void setSchemaResource(String schemaResource)
                       throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

write

public void write(Record object)

writeExport

public void writeExport(OsnSerializer exportsSerializer,
               String referenceId,
               String compositeTypeName,
               String objectSubset)
                 throws IOException

Throws:

IOException