org.openstreetmap.osmosis.core.mysql.v0_5.impl
Class RelationTableReader

java.lang.Object
  extended by org.openstreetmap.osmosis.core.mysql.common.BaseTableReader<T>
      extended by org.openstreetmap.osmosis.core.mysql.v0_5.impl.BaseEntityReader<EntityHistory<Relation>>
          extended by org.openstreetmap.osmosis.core.mysql.v0_5.impl.RelationTableReader
All Implemented Interfaces:
java.util.Iterator<EntityHistory<Relation>>, Releasable, ReleasableIterator<EntityHistory<Relation>>

public class RelationTableReader
extends BaseEntityReader<EntityHistory<Relation>>

Reads all relations from a database ordered by their identifier. These relations won't be populated with members and tags.

Author:
Brett Henderson

Nested Class Summary
 
Nested classes/interfaces inherited from class org.openstreetmap.osmosis.core.mysql.common.BaseTableReader
BaseTableReader.ReadResult<T>
 
Constructor Summary
RelationTableReader(DatabaseLoginCredentials loginCredentials, boolean readAllUsers)
          Creates a new instance.
 
Method Summary
protected  BaseTableReader.ReadResult<EntityHistory<Relation>> createNextValue(java.sql.ResultSet resultSet)
          Builds an entity object from the current recordset row.
protected  java.sql.ResultSet createResultSet(DatabaseContext queryDbCtx)
          Builds the result set that the reader will iterate over.
 
Methods inherited from class org.openstreetmap.osmosis.core.mysql.v0_5.impl.BaseEntityReader
readUserField
 
Methods inherited from class org.openstreetmap.osmosis.core.mysql.common.BaseTableReader
createLastValue, hasNext, next, release, remove
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RelationTableReader

public RelationTableReader(DatabaseLoginCredentials loginCredentials,
                           boolean readAllUsers)
Creates a new instance.

Parameters:
loginCredentials - Contains all information required to connect to the database.
readAllUsers - If this flag is true, all users will be read from the database regardless of their public edits flag.
Method Detail

createResultSet

protected java.sql.ResultSet createResultSet(DatabaseContext queryDbCtx)
Builds the result set that the reader will iterate over.

Specified by:
createResultSet in class BaseTableReader<EntityHistory<Relation>>
Parameters:
queryDbCtx - The database context to query against.
Returns:
A result set positioned before the first record.

createNextValue

protected BaseTableReader.ReadResult<EntityHistory<Relation>> createNextValue(java.sql.ResultSet resultSet)
Builds an entity object from the current recordset row.

Specified by:
createNextValue in class BaseTableReader<EntityHistory<Relation>>
Parameters:
resultSet - The record set to retrieve the data from.
Returns:
The result of the read.