com.revolsys.io.saif

Class SaifReader

java.lang.Object

com.revolsys.io.AbstractObjectWithProperties

com.revolsys.io.AbstractReader<Record>

com.revolsys.io.saif.SaifReader

All Implemented Interfaces:

RecordReader, RecordDefinitionFactory, RecordIterator, ObjectWithProperties, Reader<Record>, AutoCloseable, Iterable<Record>, Iterator<Record>

public class SaifReader
extends AbstractReader<Record>
implements RecordIterator, RecordDefinitionFactory, RecordReader

The SaifReader.

Author:

Paul Austin

See Also:

SaifWriter

Constructor Summary

Constructors

Constructor and Description
SaifReader()
SaifReader(File file) Create a new SaifReader to read the SAIF archive from the specified file .
SaifReader(org.springframework.core.io.Resource resource)
SaifReader(String fileName) Create a new SaifReader to read the SAIF archive from the specified file name.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the SAIF archive.
RecordDefinitionFactory	getDeclaredRecordDefinitionFactory() Get the schema definition declared in the SAIF archive.
Record	getExportedObjects() Get the list of exported objects for the SAIF archive.
RecordFactory	getFactory()
File	getFile()
Record	getGlobalMetadata() Get the global metatdata for the SAIF archive.
Record	getImportedObjects() Get the list of imported objects for the SAIF archive.
Record	getInternallyReferencedObjects() Get the list of internally referenced objects for the SAIF archive.
OsnReader	getOsnReader(String className)
<D extends Record> OsnReader	getOsnReader(String className, RecordFactory factory)
RecordDefinition	getRecordDefinition()
RecordDefinition	getRecordDefinition(String typePath)
RecordDefinitionFactory	getRecordDefinitionFactory() Get the schema definition that will be set on each data object.
int	getSrid()
Map<String,String>	getTypeNameFileNameMap()
List<String>	getTypeNames()
boolean	hasNext() Check to see if the reader has more data objects to be read.
Iterator<Record>	iterator() Return a new iterator for type T at the first item to read.
Record	next() Get the next data object read by this reader.
void	open() Open a SAIF archive, extracting compressed archives to a temporary directory.
protected Record	readObject(String className, RecordFactory factory)
void	remove() Removing SAIF objects is not supported.
void	setDeclaredRecordDefinitionFactory(RecordDefinitionFactory declaredRecordDefinitionFactory) Set the schema definition declared in the SAIF archive.
void	setExcludeTypeNames(Collection<String> excludeTypeNames)
void	setFactory(RecordFactory factory)
void	setFile(File file)
void	setIncludeTypeNames(Collection<String> includeTypeNames)
void	setRecordDefinitionFactory(RecordDefinitionFactory recordDefinitionFactory) Set the schema definition that will be set on each data object.
void	setSrid(int srid)
void	setTypeNameFileNameMap(Map<String,String> typePathObjectSetMap)
String	toString()

Methods inherited from class com.revolsys.io.AbstractReader

read, visit

Methods inherited from class com.revolsys.io.AbstractObjectWithProperties

clearProperties, getProperties, getProperty, getProperty, removeProperty, setProperties, setProperty, 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.Reader

read, visit

Methods inherited from interface com.revolsys.io.ObjectWithProperties

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

Constructor Detail

SaifReader

public SaifReader()

SaifReader

public SaifReader(File file)

Create a new SaifReader to read the SAIF archive from the specified file . If the file is a directory, then in must contain an expanded SAIF archive, otherwise the file must be a compressed SAIF archive (.zip or.saf).

Parameters:

file - The SAIF archive file to read.

SaifReader

public SaifReader(org.springframework.core.io.Resource resource)

SaifReader

public SaifReader(String fileName)

Create a new SaifReader to read the SAIF archive from the specified file name. If the file is a directory, then in must contain an expanded SAIF archive, otherwise the file must be a compressed SAIF archive (.zip or.saf).

Parameters:

fileName - The name of the SAIF archive file to read.

Method Detail

close

public void close()

Close the SAIF archive.

Specified by:

close in interface RecordIterator

Specified by:

close in interface Reader<Record>

Specified by:

close in interface AutoCloseable

Overrides:

close in class AbstractObjectWithProperties

getDeclaredRecordDefinitionFactory

public RecordDefinitionFactory getDeclaredRecordDefinitionFactory()

Get the schema definition declared in the SAIF archive.

Returns:

The schema definition.

getExportedObjects

public Record getExportedObjects()

Get the list of exported objects for the SAIF archive.

Returns:

The exported objects.

getFactory

public RecordFactory getFactory()

Returns:

the factory

getFile

public File getFile()

getGlobalMetadata

public Record getGlobalMetadata()

Get the global metatdata for the SAIF archive.

Returns:

The global metadata.

getImportedObjects

public Record getImportedObjects()

Get the list of imported objects for the SAIF archive.

Returns:

The imported objects.

getInternallyReferencedObjects

public Record getInternallyReferencedObjects()

Get the list of internally referenced objects for the SAIF archive.

Returns:

The internally referenced objects.

getOsnReader

public OsnReader getOsnReader(String className)
                       throws IOException

Throws:

IOException

getOsnReader

public <D extends Record> OsnReader getOsnReader(String className,
                                        RecordFactory factory)
                       throws IOException

Throws:

IOException

getRecordDefinition

public RecordDefinition getRecordDefinition()

Specified by:

getRecordDefinition in interface RecordReader

getRecordDefinition

public RecordDefinition getRecordDefinition(String typePath)

Specified by:

getRecordDefinition in interface RecordDefinitionFactory

getRecordDefinitionFactory

public RecordDefinitionFactory getRecordDefinitionFactory()

Get the schema definition that will be set on each data object.

Returns:

The schema definition.

getSrid

public int getSrid()

getTypeNameFileNameMap

public Map<String,String> getTypeNameFileNameMap()

Returns:

the typePathObjectSetMap

getTypeNames

public List<String> getTypeNames()

hasNext

public boolean hasNext()

Check to see if the reader has more data objects to be read.

Specified by:

hasNext in interface Iterator<Record>

Returns:

True if the reader has more data objects to be read.

iterator

public Iterator<Record> iterator()

Description copied from interface: Reader

Return a new iterator for type T at the first item to read. Subsequent calls to this method must return a new iterator. Implementors of this are responsible for cleaning up the iterator when the hasNext or next method on iterator reaches the end of the items to read.

Specified by:

iterator in interface Reader<Record>

Specified by:

iterator in interface Iterable<Record>

Returns:

The iterator.

next

public Record next()

Get the next data object read by this reader. .

Specified by:

next in interface RecordIterator

Specified by:

next in interface Iterator<Record>

Returns:

The next Record.

Throws:

NoSuchElementException - If the reader has no more data objects.

open

public void open()

Open a SAIF archive, extracting compressed archives to a temporary directory.

Specified by:

open in interface RecordIterator

Specified by:

open in interface Reader<Record>

readObject

protected Record readObject(String className,
                RecordFactory factory)
                     throws IOException

Throws:

IOException

remove

public void remove()

Removing SAIF objects is not supported.

Specified by:

remove in interface Iterator<Record>

Throws:

UnsupportedOperationException

setDeclaredRecordDefinitionFactory

public void setDeclaredRecordDefinitionFactory(RecordDefinitionFactory declaredRecordDefinitionFactory)

Set the schema definition declared in the SAIF archive.

Parameters:

declaredSchema - The schema definition.

setExcludeTypeNames

public void setExcludeTypeNames(Collection<String> excludeTypeNames)

Parameters:

excludeTypeNames - the excludeTypeNames to set

setFactory

public void setFactory(RecordFactory factory)

Parameters:

factory - the factory to set

setFile

public void setFile(File file)

setIncludeTypeNames

public void setIncludeTypeNames(Collection<String> includeTypeNames)

Parameters:

includeTypeNames - the includeTypeNames to set

setRecordDefinitionFactory

public void setRecordDefinitionFactory(RecordDefinitionFactory recordDefinitionFactory)

Set the schema definition that will be set on each data object.

Parameters:

schema - The schema definition.

setSrid

public void setSrid(int srid)

setTypeNameFileNameMap

public void setTypeNameFileNameMap(Map<String,String> typePathObjectSetMap)

Parameters:

typePathObjectSetMap - the typePathObjectSetMap to set

toString

public String toString()

Specified by:

toString in interface RecordIterator

Overrides:

toString in class Object