Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.database
Class DbContentTag

java.lang.Object
  extended by com.jivesoftware.forum.database.DbContentTag
All Implemented Interfaces:
JiveObject, ContentTag, Cacheable, com.tangosol.io.ExternalizableLite, java.io.Serializable

public class DbContentTag
extends java.lang.Object
implements ContentTag, Cacheable, com.tangosol.io.ExternalizableLite

Database implementation of the Tag interface.

See Also:
ContentTag, Serialized Form

Field Summary
protected  java.lang.String filteredName
           
 
Fields inherited from interface com.jivesoftware.forum.ContentTag
SORT_TAGCOUNT, SORT_TAGNAME
 
Constructor Summary
  DbContentTag()
           
protected DbContentTag(long id)
          Loads a DbTag from the database based on its id.
protected DbContentTag(java.lang.String tagname)
          Loads a DbTag from the database based on its id.
 
Method Summary
 boolean equals(java.lang.Object object)
           
 int getCachedSize()
          Returns the approximate size of the Object in bytes.
 java.util.Date getCreationDate()
          Returns the date that this tag was created.
static long getFilterExpiration()
          Returns the time (in milleseconds) that filtered output can be cached before being expired.
 long getID()
          Retrieve the unique identifier for the jive object.
 java.lang.String getName()
          The name of the tag
 int getObjectType()
          Return the object type of the jive object.
 java.lang.String getUnfilteredName()
          The unfiltered name of the tag
 int hashCode()
           
protected  void insertIntoDb()
           
 void readExternal(java.io.DataInput in)
           
 void setCreationDate(java.util.Date creationDate)
          Sets the creation date of this tag.
static void setFilterExpiration(long filterExpiration)
          Sets the time (in milleseconds) that filtered output can be cached before being expired.
 void setName(java.lang.String name)
           
 java.lang.String toString()
           
 void writeExternal(java.io.DataOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

filteredName

protected java.lang.String filteredName
Constructor Detail

DbContentTag

protected DbContentTag(long id)
                throws TagObjectNotFoundException
Loads a DbTag from the database based on its id.

Parameters:
id - the unique id of the Tag to load.
Throws:
TagObjectNotFoundException

DbContentTag

protected DbContentTag(java.lang.String tagname)
                throws TagObjectNotFoundException
Loads a DbTag from the database based on its id.

Parameters:
tagname - the unique tagname of the Tag to load
Throws:
TagObjectNotFoundException

DbContentTag

public DbContentTag()
Method Detail

getID

public long getID()
Description copied from interface: JiveObject
Retrieve the unique identifier for the jive object.

Specified by:
getID in interface JiveObject
Returns:
the unique identifier for the jive object.

getObjectType

public int getObjectType()
Description copied from interface: JiveObject
Return the object type of the jive object.

Specified by:
getObjectType in interface JiveObject
Returns:
the object type of the jive object.

getCreationDate

public java.util.Date getCreationDate()
Description copied from interface: ContentTag
Returns the date that this tag was created.

Specified by:
getCreationDate in interface ContentTag
Returns:
the date this tag was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)
Description copied from interface: ContentTag
Sets the creation date of this tag. In most cases, the creation date will default to when the tag was entered into the system. However, the creation date needs to be set manually when importing data.

Specified by:
setCreationDate in interface ContentTag
Parameters:
creationDate - the date this tag was created.

getUnfilteredName

public java.lang.String getUnfilteredName()
Description copied from interface: ContentTag
The unfiltered name of the tag

Specified by:
getUnfilteredName in interface ContentTag
Returns:
the unfiltered tag name

getName

public java.lang.String getName()
Description copied from interface: ContentTag
The name of the tag

Specified by:
getName in interface ContentTag
Returns:
the tag name

setName

public void setName(java.lang.String name)

getFilterExpiration

public static long getFilterExpiration()
Returns the time (in milleseconds) that filtered output can be cached before being expired. By default, the value is -1, which means the filtered output is never expired except when the message is expired from cache. Setting a non-negative expiration time is useful in cases where one or more filters is time senstive; for example, a filter that converts a ticker symbol into a live stock quote.

Returns:
the time (in milliseconds) that filtered output can be cached, or -1 if it can be cached indefinitely.

setFilterExpiration

public static void setFilterExpiration(long filterExpiration)
Sets the time (in milleseconds) that filtered output can be cached before being expired. By default, the value is -1, which means the filtered output is never expired except when the message is expired from cache. Setting a non-negative expiration time is useful in cases where one or more filters is time senstive; for example, a filter that converts a ticker symbol into a live stock quote.

Parameters:
filterExpiration - the time (in milliseconds) that filtered output can be cached, or -1 if it can be cached indefinitely.

insertIntoDb

protected void insertIntoDb()

getCachedSize

public int getCachedSize()
Description copied from interface: Cacheable
Returns the approximate size of the Object in bytes. The size should be considered to be a best estimate of how much memory the Object occupies and may be based on empirical trials or dynamic calculations.

Specified by:
getCachedSize in interface Cacheable
Returns:
the size of the Object in bytes.

toString

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

hashCode

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

equals

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

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException
Specified by:
readExternal in interface com.tangosol.io.ExternalizableLite
Throws:
java.io.IOException

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface com.tangosol.io.ExternalizableLite
Throws:
java.io.IOException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.