com.evernote.edam.notestore
Class NotesMetadataList

java.lang.Object
  com.evernote.edam.notestore.NotesMetadataList

All Implemented Interfaces:

TBase<NotesMetadataList>, Serializable, Cloneable, Comparable<NotesMetadataList>

public class NotesMetadataList
extends Object
implements TBase<NotesMetadataList>, Serializable, Cloneable

This structure is returned from calls to the findNotesMetadata function to give the high-level metadata about a subset of Notes that are found to match a specified NoteFilter in a search.

startIndex

The starting index within the overall set of notes. This is also the number of notes that are "before" this list in the set.

totalNotes

The number of notes in the larger set. This can be used to calculate how many notes are "after" this note in the set. (I.e. remaining = totalNotes - (startIndex + notes.length) )

notes

The list of metadata for Notes in this range. The set of optional fields that are set in each metadata structure will depend on the NotesMetadataResultSpec provided by the caller when the search was performed. Only the 'guid' field will be guaranteed to be set in each Note.

stoppedWords

If the NoteList was produced using a text based search query that included words that are not indexed or searched by the service, this will include a list of those ignored words.

searchedWords

If the NoteList was produced using a text based search query that included viable search words or quoted expressions, this will include a list of those words. Any stopped words will not be included in this list.

updateCount

Indicates the total number of transactions that have been committed within the account. This reflects (for example) the number of discrete additions or modifications that have been made to the data in this account (tags, notes, resources, etc.). This number is the "high water mark" for Update Sequence Numbers (USN) within the account.

See Also:

Serialized Form

Constructor Summary

NotesMetadataList()

NotesMetadataList(int startIndex, int totalNotes, List<NoteMetadata> notes)

NotesMetadataList(NotesMetadataList other)
Performs a deep copy on other.

Method Summary

void	addToNotes(NoteMetadata elem)
void	addToSearchedWords(String elem)
void	addToStoppedWords(String elem)
void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(NotesMetadataList other)
NotesMetadataList	deepCopy() Creates a deep copy of the object.
boolean	equals(NotesMetadataList that)
boolean	equals(Object that)
List<NoteMetadata>	getNotes()
Iterator<NoteMetadata>	getNotesIterator()
int	getNotesSize()
List<String>	getSearchedWords()
Iterator<String>	getSearchedWordsIterator()
int	getSearchedWordsSize()
int	getStartIndex()
List<String>	getStoppedWords()
Iterator<String>	getStoppedWordsIterator()
int	getStoppedWordsSize()
int	getTotalNotes()
int	getUpdateCount()
int	hashCode()
boolean	isSetNotes() Returns true if field notes is set (has been asigned a value) and false otherwise
boolean	isSetSearchedWords() Returns true if field searchedWords is set (has been asigned a value) and false otherwise
boolean	isSetStartIndex() Returns true if field startIndex is set (has been asigned a value) and false otherwise
boolean	isSetStoppedWords() Returns true if field stoppedWords is set (has been asigned a value) and false otherwise
boolean	isSetTotalNotes() Returns true if field totalNotes is set (has been asigned a value) and false otherwise
boolean	isSetUpdateCount() Returns true if field updateCount is set (has been asigned a value) and false otherwise
void	read(TProtocol iprot) Reads an instance of the object from the given protocol.
void	setNotes(List<NoteMetadata> notes)
void	setNotesIsSet(boolean value)
void	setSearchedWords(List<String> searchedWords)
void	setSearchedWordsIsSet(boolean value)
void	setStartIndex(int startIndex)
void	setStartIndexIsSet(boolean value)
void	setStoppedWords(List<String> stoppedWords)
void	setStoppedWordsIsSet(boolean value)
void	setTotalNotes(int totalNotes)
void	setTotalNotesIsSet(boolean value)
void	setUpdateCount(int updateCount)
void	setUpdateCountIsSet(boolean value)
String	toString()
void	unsetNotes()
void	unsetSearchedWords()
void	unsetStartIndex()
void	unsetStoppedWords()
void	unsetTotalNotes()
void	unsetUpdateCount()
void	validate()
void	write(TProtocol oprot) Writes the object to the given protocol.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotesMetadataList

public NotesMetadataList()

NotesMetadataList

public NotesMetadataList(int startIndex,
                         int totalNotes,
                         List<NoteMetadata> notes)

NotesMetadataList

public NotesMetadataList(NotesMetadataList other)

Performs a deep copy on other.

Method Detail

deepCopy

public NotesMetadataList deepCopy()

Description copied from interface: TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface TBase<NotesMetadataList>

clear

public void clear()

Description copied from interface: TBase

Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:

clear in interface TBase<NotesMetadataList>

getStartIndex

public int getStartIndex()

setStartIndex

public void setStartIndex(int startIndex)

unsetStartIndex

public void unsetStartIndex()

isSetStartIndex

public boolean isSetStartIndex()

Returns true if field startIndex is set (has been asigned a value) and false otherwise

setStartIndexIsSet

public void setStartIndexIsSet(boolean value)

getTotalNotes

public int getTotalNotes()

setTotalNotes

public void setTotalNotes(int totalNotes)

unsetTotalNotes

public void unsetTotalNotes()

isSetTotalNotes

public boolean isSetTotalNotes()

Returns true if field totalNotes is set (has been asigned a value) and false otherwise

setTotalNotesIsSet

public void setTotalNotesIsSet(boolean value)

getNotesSize

public int getNotesSize()

getNotesIterator

public Iterator<NoteMetadata> getNotesIterator()

addToNotes

public void addToNotes(NoteMetadata elem)

getNotes

public List<NoteMetadata> getNotes()

setNotes

public void setNotes(List<NoteMetadata> notes)

unsetNotes

public void unsetNotes()

isSetNotes

public boolean isSetNotes()

Returns true if field notes is set (has been asigned a value) and false otherwise

setNotesIsSet

public void setNotesIsSet(boolean value)

getStoppedWordsSize

public int getStoppedWordsSize()

getStoppedWordsIterator

public Iterator<String> getStoppedWordsIterator()

addToStoppedWords

public void addToStoppedWords(String elem)

getStoppedWords

public List<String> getStoppedWords()

setStoppedWords

public void setStoppedWords(List<String> stoppedWords)

unsetStoppedWords

public void unsetStoppedWords()

isSetStoppedWords

public boolean isSetStoppedWords()

Returns true if field stoppedWords is set (has been asigned a value) and false otherwise

setStoppedWordsIsSet

public void setStoppedWordsIsSet(boolean value)

getSearchedWordsSize

public int getSearchedWordsSize()

getSearchedWordsIterator

public Iterator<String> getSearchedWordsIterator()

addToSearchedWords

public void addToSearchedWords(String elem)

getSearchedWords

public List<String> getSearchedWords()

setSearchedWords

public void setSearchedWords(List<String> searchedWords)

unsetSearchedWords

public void unsetSearchedWords()

isSetSearchedWords

public boolean isSetSearchedWords()

Returns true if field searchedWords is set (has been asigned a value) and false otherwise

setSearchedWordsIsSet

public void setSearchedWordsIsSet(boolean value)

getUpdateCount

public int getUpdateCount()

setUpdateCount

public void setUpdateCount(int updateCount)

unsetUpdateCount

public void unsetUpdateCount()

isSetUpdateCount

public boolean isSetUpdateCount()

Returns true if field updateCount is set (has been asigned a value) and false otherwise

setUpdateCountIsSet

public void setUpdateCountIsSet(boolean value)

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equals

public boolean equals(NotesMetadataList that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(NotesMetadataList other)

Specified by:

compareTo in interface Comparable<NotesMetadataList>

read

public void read(TProtocol iprot)
          throws TException

Description copied from interface: TBase

Reads an instance of the object from the given protocol.

Specified by:

read in interface TBase<NotesMetadataList>

Parameters:

iprot - Input protocol

Throws:

TException

write

public void write(TProtocol oprot)
           throws TException

Description copied from interface: TBase

Writes the object to the given protocol.

Specified by:

write in interface TBase<NotesMetadataList>

Parameters:

oprot - Output protocol

Throws:

TException

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws TException

Throws:

TException