com.evernote.edam.notestore
Class NoteList

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

public class NoteList
extends java.lang.Object
implements org.apache.thrift.TBase<NoteList._Fields>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<NoteList>

A small structure for returning a list of notes out of a larger set.

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 notes from this range. The Notes will include all metadata (attributes, resources, etc.), but will not include the ENML content of the note or the binary contents of any resources.
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.

See Also:
Serialized Form

Nested Class Summary
static class NoteList._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static java.util.Map<NoteList._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
           
 
Constructor Summary
NoteList()
           
NoteList(int startIndex, int totalNotes, java.util.List<Note> notes)
           
NoteList(NoteList other)
          Performs a deep copy on other.
 
Method Summary
 void addToNotes(Note elem)
           
 void addToSearchedWords(java.lang.String elem)
           
 void addToStoppedWords(java.lang.String elem)
           
 NoteList clone()
          Deprecated. 
 int compareTo(NoteList other)
           
 NoteList deepCopy()
           
 boolean equals(NoteList that)
           
 boolean equals(java.lang.Object that)
           
 java.lang.Object getFieldValue(int fieldId)
           
 java.lang.Object getFieldValue(NoteList._Fields field)
           
 java.util.List<Note> getNotes()
           
 java.util.Iterator<Note> 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 hashCode()
           
 boolean isSet(int fieldID)
           
 boolean isSet(NoteList._Fields field)
          Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
 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
 void read(org.apache.thrift.protocol.TProtocol iprot)
           
 void setFieldValue(int fieldID, java.lang.Object value)
           
 void setFieldValue(NoteList._Fields field, java.lang.Object value)
           
 void setNotes(java.util.List<Note> 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)
           
 java.lang.String toString()
           
 void unsetNotes()
           
 void unsetSearchedWords()
           
 void unsetStartIndex()
           
 void unsetStoppedWords()
           
 void unsetTotalNotes()
           
 void validate()
           
 void write(org.apache.thrift.protocol.TProtocol oprot)
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

metaDataMap

public static final java.util.Map<NoteList._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
Constructor Detail

NoteList

public NoteList()

NoteList

public NoteList(int startIndex,
                int totalNotes,
                java.util.List<Note> notes)

NoteList

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

Method Detail

deepCopy

public NoteList deepCopy()
Specified by:
deepCopy in interface org.apache.thrift.TBase<NoteList._Fields>

clone

@Deprecated
public NoteList clone()
Deprecated. 

Overrides:
clone in class java.lang.Object

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<Note> getNotesIterator()

addToNotes

public void addToNotes(Note elem)

getNotes

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

setNotes

public void setNotes(java.util.List<Note> 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)

setFieldValue

public void setFieldValue(NoteList._Fields field,
                          java.lang.Object value)
Specified by:
setFieldValue in interface org.apache.thrift.TBase<NoteList._Fields>

setFieldValue

public void setFieldValue(int fieldID,
                          java.lang.Object value)
Specified by:
setFieldValue in interface org.apache.thrift.TBase<NoteList._Fields>

getFieldValue

public java.lang.Object getFieldValue(NoteList._Fields field)
Specified by:
getFieldValue in interface org.apache.thrift.TBase<NoteList._Fields>

getFieldValue

public java.lang.Object getFieldValue(int fieldId)
Specified by:
getFieldValue in interface org.apache.thrift.TBase<NoteList._Fields>

isSet

public boolean isSet(NoteList._Fields field)
Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise

Specified by:
isSet in interface org.apache.thrift.TBase<NoteList._Fields>

isSet

public boolean isSet(int fieldID)
Specified by:
isSet in interface org.apache.thrift.TBase<NoteList._Fields>

equals

public boolean equals(java.lang.Object that)
Overrides:
equals in class java.lang.Object

equals

public boolean equals(NoteList that)

hashCode

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

compareTo

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

read

public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
Specified by:
read in interface org.apache.thrift.TBase<NoteList._Fields>
Throws:
org.apache.thrift.TException

write

public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
Specified by:
write in interface org.apache.thrift.TBase<NoteList._Fields>
Throws:
org.apache.thrift.TException

toString

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

validate

public void validate()
              throws org.apache.thrift.TException
Throws:
org.apache.thrift.TException