com.liferay.portal.kernel.model.wrapper

Class BaseModelWrapper<T extends BaseModel<T>>

Object

com.liferay.portal.kernel.model.wrapper.BaseModelWrapper<T>

All Implemented Interfaces:

BaseModel<T>, ClassedModel, ModelWrapper<T>, Serializable, Cloneable, Comparable<T>

Direct Known Subclasses:

AccountWrapper, AddressWrapper, AnnouncementsDeliveryWrapper, AnnouncementsEntryWrapper, AnnouncementsFlagWrapper, AssetCategoryPropertyWrapper, AssetCategoryWrapper, AssetEntryWrapper, AssetLinkWrapper, AssetTagStatsWrapper, AssetTagWrapper, AssetVocabularyWrapper, BrowserTrackerWrapper, ClassNameWrapper, ClusterGroupWrapper, CompanyWrapper, ContactWrapper, CounterWrapper, CountryWrapper, DLFileEntryMetadataWrapper, DLFileEntryTypeWrapper, DLFileEntryWrapper, DLFileShortcutWrapper, DLFileVersionWrapper, DLFolderWrapper, EmailAddressWrapper, ExpandoColumnWrapper, ExpandoRowWrapper, ExpandoTableWrapper, ExpandoValueWrapper, ExportImportConfigurationWrapper, GroupWrapper, ImageWrapper, LayoutBranchWrapper, LayoutFriendlyURLWrapper, LayoutPrototypeWrapper, LayoutRevisionWrapper, LayoutSetBranchWrapper, LayoutSetPrototypeWrapper, LayoutSetVersionWrapper, LayoutSetWrapper, LayoutVersionWrapper, LayoutWrapper, ListTypeWrapper, MembershipRequestWrapper, OrganizationWrapper, OrgGroupRoleWrapper, OrgLaborWrapper, PasswordPolicyRelWrapper, PasswordPolicyWrapper, PasswordTrackerWrapper, PhoneWrapper, PluginSettingWrapper, PortalPreferencesWrapper, PortletItemWrapper, PortletPreferencesWrapper, PortletWrapper, RatingsEntryWrapper, RatingsStatsWrapper, RecentLayoutBranchWrapper, RecentLayoutRevisionWrapper, RecentLayoutSetBranchWrapper, RegionWrapper, ReleaseWrapper, RepositoryEntryWrapper, RepositoryWrapper, ResourceActionWrapper, ResourceBlockPermissionWrapper, ResourceBlockWrapper, ResourcePermissionWrapper, ResourceTypePermissionWrapper, RoleWrapper, ServiceComponentWrapper, SocialActivityAchievementWrapper, SocialActivityCounterWrapper, SocialActivityLimitWrapper, SocialActivitySettingWrapper, SocialActivitySetWrapper, SocialActivityWrapper, SocialRelationWrapper, SocialRequestWrapper, SubscriptionWrapper, SystemEventWrapper, TeamWrapper, TicketWrapper, UserGroupGroupRoleWrapper, UserGroupRoleWrapper, UserGroupWrapper, UserIdMapperWrapper, UserNotificationDeliveryWrapper, UserNotificationEventWrapper, UserTrackerPathWrapper, UserTrackerWrapper, UserWrapper, VirtualHostWrapper, WebDAVPropsWrapper, WebsiteWrapper, WorkflowDefinitionLinkWrapper, WorkflowInstanceLinkWrapper

public abstract class BaseModelWrapper<T extends BaseModel<T>>
extends Object
implements BaseModel<T>, ModelWrapper<T>

Author:

Preston Crary

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T	model

Constructor Summary

Constructors

Constructor and Description
BaseModelWrapper(T model)

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a shallow clone of this model instance.
int	compareTo(T o)
boolean	equals(Object object)
ExpandoBridge	getExpandoBridge() Returns the expando bridge for this model instance.
Class<?>	getModelClass()
String	getModelClassName()
Serializable	getPrimaryKeyObj() Returns the primary key of this model instance.
T	getWrappedModel()
int	hashCode()
boolean	isCachedModel() Returns true if this model instance was retrieved from the entity cache.
boolean	isEntityCacheEnabled() Returns true if this model's entity cache is enabled.
boolean	isEscapedModel() Returns true if this model instance is escaped.
boolean	isFinderCacheEnabled() Returns true if this model's finder cache is enabled.
boolean	isNew() Returns true if this model instance does not yet exist in the database.
void	resetOriginalValues() Reset all original fields to current values.
void	setCachedModel(boolean cachedModel) Sets whether this model instance was retrieved from the entity cache.
void	setExpandoBridgeAttributes(BaseModel<?> baseModel)
void	setExpandoBridgeAttributes(ExpandoBridge expandoBridge)
void	setExpandoBridgeAttributes(ServiceContext serviceContext) Sets the expando bridge attributes for this model instance to the attributes stored in the service context.
void	setNew(boolean n) Sets whether this model instance does not yet exist in the database.
void	setPrimaryKeyObj(Serializable primaryKeyObj) Sets the primary key of this model instance.
CacheModel<T>	toCacheModel() Returns a cache model object for this entity used by entity cache.
T	toEscapedModel() Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.
String	toString()
T	toUnescapedModel()
String	toXmlString() Returns the XML representation of this model instance.
protected abstract T	wrap(T model)

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.liferay.portal.kernel.model.BaseModel

getModelAttributes, setModelAttributes

Field Detail

model

protected final T extends BaseModel<T> model

Constructor Detail

BaseModelWrapper

public BaseModelWrapper(T model)

Method Detail

clone

public Object clone()

Description copied from interface: BaseModel

Creates a shallow clone of this model instance.

Specified by:

clone in interface BaseModel<T extends BaseModel<T>>

Overrides:

clone in class Object

Returns:

the shallow clone of this model instance

compareTo

public int compareTo(T o)

Specified by:

compareTo in interface Comparable<T extends BaseModel<T>>

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getExpandoBridge

public ExpandoBridge getExpandoBridge()

Description copied from interface: BaseModel

Returns the expando bridge for this model instance.

Specified by:

getExpandoBridge in interface BaseModel<T extends BaseModel<T>>

Specified by:

getExpandoBridge in interface ClassedModel

Returns:

the expando bridge for this model instance

getModelClass

public Class<?> getModelClass()

Specified by:

getModelClass in interface ClassedModel

getModelClassName

public String getModelClassName()

Specified by:

getModelClassName in interface ClassedModel

getPrimaryKeyObj

public Serializable getPrimaryKeyObj()

Description copied from interface: BaseModel

Returns the primary key of this model instance.

Specified by:

getPrimaryKeyObj in interface BaseModel<T extends BaseModel<T>>

Specified by:

getPrimaryKeyObj in interface ClassedModel

Returns:

the primary key of this model instance

getWrappedModel

public T getWrappedModel()

Specified by:

getWrappedModel in interface ModelWrapper<T extends BaseModel<T>>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCachedModel

public boolean isCachedModel()

Description copied from interface: BaseModel

Returns true if this model instance was retrieved from the entity cache.

Specified by:

isCachedModel in interface BaseModel<T extends BaseModel<T>>

Returns:

true if this model instance was retrieved from the entity cache; false otherwise

See Also:

BaseModel.setCachedModel(boolean)

isEntityCacheEnabled

public boolean isEntityCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's entity cache is enabled.

Specified by:

isEntityCacheEnabled in interface BaseModel<T extends BaseModel<T>>

Returns:

true if this model's entity cache is enabled; false otherwise

isEscapedModel

public boolean isEscapedModel()

Description copied from interface: BaseModel

Returns true if this model instance is escaped.

Specified by:

isEscapedModel in interface BaseModel<T extends BaseModel<T>>

Returns:

true if this model instance is escaped; false otherwise

isFinderCacheEnabled

public boolean isFinderCacheEnabled()

Description copied from interface: BaseModel

Returns true if this model's finder cache is enabled.

Specified by:

isFinderCacheEnabled in interface BaseModel<T extends BaseModel<T>>

Returns:

true if this model's finder cache is enabled; false otherwise

isNew

public boolean isNew()

Description copied from interface: BaseModel

Returns true if this model instance does not yet exist in the database.

Specified by:

isNew in interface BaseModel<T extends BaseModel<T>>

Returns:

true if this model instance does not yet exist in the database; false otherwise

resetOriginalValues

public void resetOriginalValues()

Description copied from interface: BaseModel

Reset all original fields to current values.

Specified by:

resetOriginalValues in interface BaseModel<T extends BaseModel<T>>

setCachedModel

public void setCachedModel(boolean cachedModel)

Description copied from interface: BaseModel

Sets whether this model instance was retrieved from the entity cache.

Specified by:

setCachedModel in interface BaseModel<T extends BaseModel<T>>

Parameters:

cachedModel - whether this model instance was retrieved from the entity cache

See Also:

EntityCache

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(BaseModel<?> baseModel)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<T extends BaseModel<T>>

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge)

Specified by:

setExpandoBridgeAttributes in interface BaseModel<T extends BaseModel<T>>

setExpandoBridgeAttributes

public void setExpandoBridgeAttributes(ServiceContext serviceContext)

Description copied from interface: BaseModel

Sets the expando bridge attributes for this model instance to the attributes stored in the service context.

Specified by:

setExpandoBridgeAttributes in interface BaseModel<T extends BaseModel<T>>

Parameters:

serviceContext - the service context to be applied

See Also:

ServiceContext.getExpandoBridgeAttributes()

setNew

public void setNew(boolean n)

Description copied from interface: BaseModel

Sets whether this model instance does not yet exist in the database.

Specified by:

setNew in interface BaseModel<T extends BaseModel<T>>

Parameters:

n - whether this model instance does not yet exist in the database

setPrimaryKeyObj

public void setPrimaryKeyObj(Serializable primaryKeyObj)

Description copied from interface: BaseModel

Sets the primary key of this model instance.

Specified by:

setPrimaryKeyObj in interface BaseModel<T extends BaseModel<T>>

Specified by:

setPrimaryKeyObj in interface ClassedModel

Parameters:

primaryKeyObj - the primary key of this model instance

toCacheModel

public CacheModel<T> toCacheModel()

Description copied from interface: BaseModel

Returns a cache model object for this entity used by entity cache.

Specified by:

toCacheModel in interface BaseModel<T extends BaseModel<T>>

Returns:

the cache model object

toEscapedModel

public T toEscapedModel()

Description copied from interface: BaseModel

Returns a copy of this entity as an escaped model instance by wrapping it with an AutoEscapeBeanHandler.

Specified by:

toEscapedModel in interface BaseModel<T extends BaseModel<T>>

Returns:

the escaped model instance

See Also:

AutoEscapeBeanHandler

toString

public String toString()

Overrides:

toString in class Object

toUnescapedModel

public T toUnescapedModel()

Specified by:

toUnescapedModel in interface BaseModel<T extends BaseModel<T>>

toXmlString

public String toXmlString()

Description copied from interface: BaseModel

Returns the XML representation of this model instance.

Specified by:

toXmlString in interface BaseModel<T extends BaseModel<T>>

Returns:

the XML representation of this model instance

wrap

protected abstract T wrap(T model)