Class Vote

java.lang.Object
com.erudika.para.core.Vote
All Implemented Interfaces:
Linkable, ParaObject, Votable, Serializable
public class Vote extends Object implements ParaObject
When a user votes on an object the vote is saved as positive or negative. The user has a short amount of time to amend that vote and then it's locked. Votes can expire after X seconds and they get deleted. This allows the voter to vote again on the same object.
Author:
Alex Bogdanovski [[email protected]]
See Also:

  • Constructor Details

    • Vote

      public Vote()
      No-args constructor.

    • Vote

      public Vote(String voterid, String voteeid, Votable.VoteValue value)
      Default constructor.
      Parameters:
      voterid - the user id of the voter
      voteeid - the id of the object that will receive the vote
      value - up + or down -

  • Method Details

    • getId

      public final String getId()
      Description copied from interface: ParaObject
      The id of an object. Usually an autogenerated unique string of numbers.
      Specified by:
      getId in interface ParaObject
      Returns:
      the id

    • up

      public Vote up()
      Set the vote positive.
      Returns:
      this

    • down

      public Vote down()
      Set the vote negative.
      Returns:
      this

    • isUpvote

      public boolean isUpvote()
      Returns true if the vote is positive.
      Returns:
      true if vote is positive

    • isDownvote

      public boolean isDownvote()
      Returns true if the vote is negative.
      Returns:
      true if vote is negative

    • getValue

      public String getValue()
      Returns the value of the vote.
      Returns:
      UP or DOWN

    • setValue

      public void setValue(String value)
      Sets the value of the vote.
      Parameters:
      value - UP or DOWN

    • getExpiresAfter

      public Integer getExpiresAfter()
      Returns the expiration period.
      Returns:
      time in seconds

    • setExpiresAfter

      public void setExpiresAfter(Integer expiresAfter)
      Sets the expiration period.
      Parameters:
      expiresAfter - time in seconds

    • getLockedAfter

      public Integer getLockedAfter()
      The period during which a vote can be amended.
      Returns:
      lock after period in seconds

    • setLockedAfter

      public void setLockedAfter(Integer lockedAfter)
      Sets the lock after period.
      Parameters:
      lockedAfter - time in seconds

    • isExpired

      public boolean isExpired()
      Checks if expired.
      Returns:
      true if expired

    • isAmendable

      public boolean isAmendable()
      Checks if vote can still be amended.
      Returns:
      true if vote can still be changed

    • setId

      public final void setId(String id)
      Sets the object ID.
      Specified by:
      setId in interface ParaObject
      Parameters:
      id - the id

    • getType

      public final String getType()
      Returns the object type.
      Specified by:
      getType in interface ParaObject
      Returns:
      the type

    • setType

      public final void setType(String type)
      Sets the object type.
      Specified by:
      setType in interface ParaObject
      Parameters:
      type - the type

    • getAppid

      public String getAppid()
      Returns the app identifier.
      Specified by:
      getAppid in interface ParaObject
      Returns:
      the appid

    • setAppid

      public void setAppid(String appid)
      Sets the app identifier.
      Specified by:
      setAppid in interface ParaObject
      Parameters:
      appid - the appid

    • getObjectURI

      public String getObjectURI()
      Returns the object URI.
      Specified by:
      getObjectURI in interface ParaObject
      Returns:
      the URI
      See Also:

    • getTags

      public List<String> getTags()
      Returns the tags.
      Specified by:
      getTags in interface ParaObject
      Returns:
      empty list
      See Also:

    • setTags

      public void setTags(List<String> tags)
      Sets the tags (noop).
      Specified by:
      setTags in interface ParaObject
      Parameters:
      tags - tags

    • getStored

      public Boolean getStored()
      Returns true if the object is stored in the database.
      Specified by:
      getStored in interface ParaObject
      Returns:
      true if stored

    • setStored

      public void setStored(Boolean stored)
      Sets the stored flag.
      Specified by:
      setStored in interface ParaObject
      Parameters:
      stored - stored flag

    • getIndexed

      public Boolean getIndexed()
      Returns true if the object is indexed.
      Specified by:
      getIndexed in interface ParaObject
      Returns:
      true if indexed

    • setIndexed

      public void setIndexed(Boolean indexed)
      Sets the indexed flag.
      Specified by:
      setIndexed in interface ParaObject
      Parameters:
      indexed - indexed flag

    • getCached

      public Boolean getCached()
      Returns true if the object is cached.
      Specified by:
      getCached in interface ParaObject
      Returns:
      true if cached

    • setCached

      public void setCached(Boolean cached)
      Sets the cached flag.
      Specified by:
      setCached in interface ParaObject
      Parameters:
      cached - cached flag

    • getTimestamp

      public Long getTimestamp()
      Returns the timestamp.
      Specified by:
      getTimestamp in interface ParaObject
      Returns:
      the timestamp

    • setTimestamp

      public void setTimestamp(Long timestamp)
      Sets the timestamp.
      Specified by:
      setTimestamp in interface ParaObject
      Parameters:
      timestamp - timestamp

    • getCreatorid

      public String getCreatorid()
      Returns the creator ID.
      Specified by:
      getCreatorid in interface ParaObject
      Returns:
      creatorid

    • setCreatorid

      public void setCreatorid(String creatorid)
      Sets the creator ID.
      Specified by:
      setCreatorid in interface ParaObject
      Parameters:
      creatorid - creatorid

    • getName

      public final String getName()
      Returns the object name.
      Specified by:
      getName in interface ParaObject
      Returns:
      the name

    • setName

      public final void setName(String name)
      Sets the object name.
      Specified by:
      setName in interface ParaObject
      Parameters:
      name - name

    • getPlural

      public String getPlural()
      Returns the plural form of the object type.
      Specified by:
      getPlural in interface ParaObject
      Returns:
      plural name

    • getParentid

      public String getParentid()
      Returns the parent ID.
      Specified by:
      getParentid in interface ParaObject
      Returns:
      parentid

    • setParentid

      public void setParentid(String parentid)
      Sets the parent ID.
      Specified by:
      setParentid in interface ParaObject
      Parameters:
      parentid - parentid

    • getUpdated

      public Long getUpdated()
      Returns the updated timestamp.
      Specified by:
      getUpdated in interface ParaObject
      Returns:
      updated timestamp

    • setUpdated

      public void setUpdated(Long updated)
      Sets the updated timestamp.
      Specified by:
      setUpdated in interface ParaObject
      Parameters:
      updated - updated timestamp

    • create

      public String create()
      Persists the object to the database.
      Specified by:
      create in interface ParaObject
      Returns:
      the object ID
      See Also:

    • update

      public void update()
      Updates the object in the database.
      Specified by:
      update in interface ParaObject
      See Also:

    • delete

      public void delete()
      Deletes the object from the database.
      Specified by:
      delete in interface ParaObject
      See Also:

    • exists

      public boolean exists()
      Returns true if the object exists in the database.
      Specified by:
      exists in interface ParaObject
      Returns:
      true if exists
      See Also:

    • voteUp

      public boolean voteUp(String userid)
      Votes up (noop).
      Specified by:
      voteUp in interface Votable
      Parameters:
      userid - voter ID
      Returns:
      false

    • voteDown

      public boolean voteDown(String userid)
      Votes down (noop).
      Specified by:
      voteDown in interface Votable
      Parameters:
      userid - voter ID
      Returns:
      false

    • getVotes

      public Integer getVotes()
      Returns the number of votes (always 0).
      Specified by:
      getVotes in interface Votable
      Returns:
      0

    • setVotes

      public void setVotes(Integer votes)
      Sets the number of votes (noop).
      Specified by:
      setVotes in interface Votable
      Parameters:
      votes - votes

    • getVersion

      public Long getVersion()
      Returns the version of the object.
      Specified by:
      getVersion in interface ParaObject
      Returns:
      the version

    • setVersion

      public void setVersion(Long version)
      Sets the version of the object.
      Specified by:
      setVersion in interface ParaObject
      Parameters:
      version - version

    • countLinks

      public Long countLinks(String type2)
      Counts links (always 0).
      Specified by:
      countLinks in interface Linkable
      Parameters:
      type2 - other type
      Returns:
      0

    • getLinks

      public List<Linker> getLinks(String type2, Pager... pager)
      Returns links (empty list).
      Specified by:
      getLinks in interface Linkable
      Parameters:
      type2 - other type
      pager - pager
      Returns:
      empty list

    • getLinkedObjects

      public <P extends ParaObject> List<P> getLinkedObjects(String type, Pager... pager)
      Returns linked objects (empty list).
      Specified by:
      getLinkedObjects in interface Linkable
      Type Parameters:
      P - type
      Parameters:
      type - type
      pager - pager
      Returns:
      empty list

    • findLinkedObjects

      public <P extends ParaObject> List<P> findLinkedObjects(String type, String field, String query, Pager... pager)
      Finds linked objects (empty list).
      Specified by:
      findLinkedObjects in interface Linkable
      Type Parameters:
      P - type
      Parameters:
      type - type
      field - field
      query - query
      pager - pager
      Returns:
      empty list

    • isLinked

      public boolean isLinked(String type2, String id2)
      Is linked (always false).
      Specified by:
      isLinked in interface Linkable
      Parameters:
      type2 - other type
      id2 - other ID
      Returns:
      false

    • isLinked

      public boolean isLinked(ParaObject toObj)
      Is linked (always false).
      Specified by:
      isLinked in interface Linkable
      Parameters:
      toObj - other object
      Returns:
      false

    • link

      public String link(String id2)
      Links (noop).
      Specified by:
      link in interface Linkable
      Parameters:
      id2 - other ID
      Returns:
      null

    • unlink

      public void unlink(String type, String id2)
      Unlinks (noop).
      Specified by:
      unlink in interface Linkable
      Parameters:
      type - other type
      id2 - other ID

    • unlinkAll

      public void unlinkAll()
      Unlinks all (noop).
      Specified by:
      unlinkAll in interface Linkable

    • countChildren

      public Long countChildren(String type)
      Counts children (always 0).
      Specified by:
      countChildren in interface Linkable
      Parameters:
      type - child type
      Returns:
      0

    • getChildren

      public <P extends ParaObject> List<P> getChildren(String type, Pager... pager)
      Returns children (empty list).
      Specified by:
      getChildren in interface Linkable
      Type Parameters:
      P - type
      Parameters:
      type - type
      pager - pager
      Returns:
      empty list

    • getChildren

      public <P extends ParaObject> List<P> getChildren(String type, String field, String term, Pager... pager)
      Returns children (empty list).
      Specified by:
      getChildren in interface Linkable
      Type Parameters:
      P - type
      Parameters:
      type - type
      field - field
      term - term
      pager - pager
      Returns:
      empty list

    • findChildren

      public <P extends ParaObject> List<P> findChildren(String type, String query, Pager... pager)
      Finds children (empty list).
      Specified by:
      findChildren in interface Linkable
      Type Parameters:
      P - type
      Parameters:
      type - type
      query - query
      pager - pager
      Returns:
      empty list

    • deleteChildren

      public void deleteChildren(String type)
      Deletes children (noop).
      Specified by:
      deleteChildren in interface Linkable
      Parameters:
      type - child type

    • hashCode

      public int hashCode()
      Returns hash code.
      Overrides:
      hashCode in class Object
      Returns:
      hash code

    • equals

      public boolean equals(Object obj)
      Compares objects for equality.
      Overrides:
      equals in class Object
      Parameters:
      obj - other object
      Returns:
      true if equal

    • toString

      public String toString()
      Returns JSON string.
      Overrides:
      toString in class Object
      Returns:
      JSON string