de.westnordost.osmapi.notes

Class NotesDao

java.lang.Object

de.westnordost.osmapi.notes.NotesDao

public class NotesDao
extends java.lang.Object

Creates, comments, closes, reopens and search for notes All interactions with this class require an OsmConnection with a logged in user.

Constructor Summary

Constructors

Constructor and Description
NotesDao(OsmConnection osm)

Method Summary

Modifier and Type	Method and Description
Note	close(long id) Close aka resolve the note with the given id without providing a reason.
Note	close(long id, java.lang.String reason) Close aka resolve the note with the given id and reason.
Note	comment(long id, java.lang.String text)
Note	create(LatLon pos, java.lang.String text) Create a new note at the given location
void	find(Handler<Note> handler, QueryNotesFilters filters) Get a number of notes that match the given filters.
Note	get(long id)
void	getAll(BoundingBox bounds, Handler<Note> handler, int limit, int hideClosedNoteAfter) Retrieve all notes in the given area and feed them to the given handler.
void	getAll(BoundingBox bounds, java.lang.String search, Handler<Note> handler, int limit, int hideClosedNoteAfter) Retrieve those notes in the given area that match the given search string
Note	reopen(long id) Reopens the given note without providing a reason.
Note	reopen(long id, java.lang.String reason) Reopen the given note with the given reason.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotesDao

public NotesDao(OsmConnection osm)

Method Detail

create

public Note create(LatLon pos,
                   java.lang.String text)

Create a new note at the given location

Parameters:

pos - position of the note. Must not be null.

text - text for the new note. Must not be empty nor null.

Returns:

the new note

Throws:

OsmAuthorizationException - if this application is not authorized to write notes (Permission.WRITE_NOTES)

comment

public Note comment(long id,
                    java.lang.String text)

Parameters:

id - id of the note

text - comment to be added to the note. Must not be null or empty

Returns:

the updated commented note

Throws:

OsmConflictException - if the note has already been closed.

OsmAuthorizationException - if this application is not authorized to write notes (Permission.WRITE_NOTES)

OsmNotFoundException - if the note with the given id does not exist (anymore)

reopen

public Note reopen(long id)

Reopens the given note without providing a reason.

See Also:

reopen(long, String)

reopen

public Note reopen(long id,
                   java.lang.String reason)

Reopen the given note with the given reason. The reason is optional.

Returns:

the updated reopened note

Throws:

OsmConflictException - if the note has already been reopened.

OsmAuthorizationException - if this application is not authorized to write notes (Permission.WRITE_NOTES)

OsmNotFoundException - if the note with the given id does not exist (anymore)

close

public Note close(long id,
                  java.lang.String reason)

Close aka resolve the note with the given id and reason.

Parameters:

id - id of the note

reason - comment to be added to the note as a reason for it being closed. Optional.

Returns:

the closed note

Throws:

OsmConflictException - if the note has already been closed.

OsmAuthorizationException - if this application is not authorized to write notes (Permission.WRITE_NOTES)

OsmNotFoundException - if the note with the given id does not exist (anymore)

close

public Note close(long id)

Close aka resolve the note with the given id without providing a reason.

See Also:

close(long, String)

get

public Note get(long id)

Parameters:

id - id of the note

Returns:

the note with the given id. null if the note with that id does not exist (anymore).

Throws:

OsmAuthorizationException - if not logged in

getAll

public void getAll(BoundingBox bounds,
                   Handler<Note> handler,
                   int limit,
                   int hideClosedNoteAfter)

Retrieve all notes in the given area and feed them to the given handler.

See Also:

getAll(BoundingBox, String, Handler, int, int)

getAll

public void getAll(BoundingBox bounds,
                   java.lang.String search,
                   Handler<Note> handler,
                   int limit,
                   int hideClosedNoteAfter)

Retrieve those notes in the given area that match the given search string

Parameters:

handler - The handler which is fed the incoming notes

bounds - the area within the notes should be queried. This is usually limited at 25 square degrees. Check the server capabilities.

search - what to search for. Null to return everything.

limit - number of entries returned at maximum. Any value between 1 and 10000

hideClosedNoteAfter - number of days until a closed note should not be shown anymore. -1 means that all notes should be returned, 0 that only open notes are returned.

Throws:

OsmQueryTooBigException - if the bounds area is too large

java.lang.IllegalArgumentException - if the bounds cross the 180th meridian

OsmAuthorizationException - if not logged in

find

public void find(Handler<Note> handler,
                 QueryNotesFilters filters)

Get a number of notes that match the given filters.

Parameters:

handler - The handler which is fed the incoming notes

filters - what to search for. I.e. new QueryNotesFilters().byUser(123).limit(1000)

Throws:

OsmAuthorizationException - if not logged in