com.endeca.portal.metadata.datasource
Class MDEXStateMetadataObject

java.lang.Object
  extended by com.endeca.portal.metadata.AbstractMetadata
      extended by com.endeca.portal.metadata.MetadataObject
          extended by com.endeca.portal.metadata.datasource.MDEXStateMetadataObject
All Implemented Interfaces:
Metadata

public class MDEXStateMetadataObject
extends MetadataObject

This class represents a metadata object that represents a stored MDEXState.


Constructor Summary
MDEXStateMetadataObject(com.endeca.portal.liferay.ext.metadata.model.MetadataRecord record)
           
MDEXStateMetadataObject(java.lang.String key, java.lang.String value)
           
 
Method Summary
 java.lang.String getDataSourceJsonDefinition()
          A convenience method that returns the value under the name of what it is, a data source JSON definition.
 long getEntryVersion()
          This method returns the current entry version, which we store in the Rel value of the Liferay Metadata object.
 java.lang.String getType()
          Gets the implementation-specific type.
 void incrementEntryVersion()
          This is a convenience method to increase the current entry version of this object by 1.
 void setDataSourceJsonDefinition(java.lang.String dataSourceDefinition)
          A convenience method that sets the value under the name of what it is, a data source JSON definition.
 void setEntryVersion(long entryVersion)
          This method will explicitly set the entry version of this object to the passed long.
 
Methods inherited from class com.endeca.portal.metadata.MetadataObject
addProperties, addProperty, equals, getProperties, getProperties, getSourceRecord, init, removeAllProperties, removeProperties, removeProperties, removeProperty, setSourceRecord
 
Methods inherited from class com.endeca.portal.metadata.AbstractMetadata
getDescription, getFeature, getKey, getLastUpdated, getLocale, getObjectId, getRel, getSource, getValue, setDescription, setFeature, setKey, setLastUpdated, setLocale, setObjectId, setRel, setSource, setValue, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MDEXStateMetadataObject

public MDEXStateMetadataObject(com.endeca.portal.liferay.ext.metadata.model.MetadataRecord record)

MDEXStateMetadataObject

public MDEXStateMetadataObject(java.lang.String key,
                               java.lang.String value)
Method Detail

getType

public java.lang.String getType()
Description copied from class: MetadataObject
Gets the implementation-specific type.

Specified by:
getType in interface Metadata
Specified by:
getType in class MetadataObject
Returns:
the type of metadata this object represents
See Also:
MetadataObject.getType()

getDataSourceJsonDefinition

public java.lang.String getDataSourceJsonDefinition()
A convenience method that returns the value under the name of what it is, a data source JSON definition. This simply passes the String back.

Returns:
String

setDataSourceJsonDefinition

public void setDataSourceJsonDefinition(java.lang.String dataSourceDefinition)
A convenience method that sets the value under the name of what it is, a data source JSON definition.

Parameters:
dataSourceDefinition -

getEntryVersion

public long getEntryVersion()
This method returns the current entry version, which we store in the Rel value of the Liferay Metadata object. This method returns that value, and attempts to return it as a long. If the entry version is null or unparseable as a long, a 0 version is returned by default.

Returns:
long

setEntryVersion

public void setEntryVersion(long entryVersion)
This method will explicitly set the entry version of this object to the passed long.

Parameters:
entryVersion -

incrementEntryVersion

public void incrementEntryVersion()
This is a convenience method to increase the current entry version of this object by 1.