com.evernote.edam.notestore
Class NotesMetadataList

java.lang.Object
  extended by com.evernote.edam.notestore.NotesMetadataList
All Implemented Interfaces:
com.evernote.thrift.TBase<NotesMetadataList>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<NotesMetadataList>

public class NotesMetadataList
extends java.lang.Object
implements com.evernote.thrift.TBase<NotesMetadataList>, java.io.Serializable, java.lang.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, java.util.List<NoteMetadata> notes)
           
NotesMetadataList(NotesMetadataList other)
          Performs a deep copy on other.
 
Method Summary
 void addToNotes(NoteMetadata elem)
           
 void addToSearchedWords(java.lang.String elem)
           
 void addToStoppedWords(java.lang.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(java.lang.Object that)
           
 java.util.List<NoteMetadata> getNotes()
           
 java.util.Iterator<NoteMetadata> getNotesIterator()
           
 int getNotesSize()
           
 java.util.List<java.lang.String> getSearchedWords()
           
 java.util.Iterator<java.lang.String> getSearchedWordsIterator()
           
 int getSearchedWordsSize()
           
 int getStartIndex()
           
 java.util.List<java.lang.String> getStoppedWords()
           
 java.util.Iterator<java.lang.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(com.evernote.thrift.protocol.TProtocol iprot)
          Reads an instance of the object from the given protocol.
 void setNotes(java.util.List<NoteMetadata> notes)
           
 void setNotesIsSet(boolean value)
           
 void setSearchedWords(java.util.List<java.lang.String> searchedWords)
           
 void setSearchedWordsIsSet(boolean value)
           
 void setStartIndex(int startIndex)
           
 void setStartIndexIsSet(boolean value)
           
 void setStoppedWords(java.util.List<java.lang.String> stoppedWords)
           
 void setStoppedWordsIsSet(boolean value)
           
 void setTotalNotes(int totalNotes)
           
 void setTotalNotesIsSet(boolean value)
           
 void setUpdateCount(int updateCount)
           
 void setUpdateCountIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetNotes()
           
 void unsetSearchedWords()
           
 void unsetStartIndex()
           
 void unsetStoppedWords()
           
 void unsetTotalNotes()
           
 void unsetUpdateCount()
           
 void validate()
           
 void write(com.evernote.thrift.protocol.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,
                         java.util.List<NoteMetadata> notes)

NotesMetadataList

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

Method Detail

deepCopy

public NotesMetadataList deepCopy()
Description copied from interface: com.evernote.thrift.TBase
Creates a deep copy of the object.

Specified by:
deepCopy in interface com.evernote.thrift.TBase<NotesMetadataList>

clear

public void clear()
Description copied from interface: com.evernote.thrift.TBase
Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:
clear in interface com.evernote.thrift.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 java.util.Iterator<NoteMetadata> getNotesIterator()

addToNotes

public void addToNotes(NoteMetadata elem)

getNotes

public java.util.List<NoteMetadata> getNotes()

setNotes

public void setNotes(java.util.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 java.util.Iterator<java.lang.String> getStoppedWordsIterator()

addToStoppedWords

public void addToStoppedWords(java.lang.String elem)

getStoppedWords

public java.util.List<java.lang.String> getStoppedWords()

setStoppedWords

public void setStoppedWords(java.util.List<java.lang.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 java.util.Iterator<java.lang.String> getSearchedWordsIterator()

addToSearchedWords

public void addToSearchedWords(java.lang.String elem)

getSearchedWords

public java.util.List<java.lang.String> getSearchedWords()

setSearchedWords

public void setSearchedWords(java.util.List<java.lang.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(java.lang.Object that)
Overrides:
equals in class java.lang.Object

equals

public boolean equals(NotesMetadataList that)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

compareTo

public int compareTo(NotesMetadataList other)
Specified by:
compareTo in interface java.lang.Comparable<NotesMetadataList>

read

public void read(com.evernote.thrift.protocol.TProtocol iprot)
          throws com.evernote.thrift.TException
Description copied from interface: com.evernote.thrift.TBase
Reads an instance of the object from the given protocol.

Specified by:
read in interface com.evernote.thrift.TBase<NotesMetadataList>
Parameters:
iprot - Input protocol
Throws:
com.evernote.thrift.TException

write

public void write(com.evernote.thrift.protocol.TProtocol oprot)
           throws com.evernote.thrift.TException
Description copied from interface: com.evernote.thrift.TBase
Writes the object to the given protocol.

Specified by:
write in interface com.evernote.thrift.TBase<NotesMetadataList>
Parameters:
oprot - Output protocol
Throws:
com.evernote.thrift.TException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

validate

public void validate()
              throws com.evernote.thrift.TException
Throws:
com.evernote.thrift.TException