001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.model.impl;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscapeBeanHandler;
020    import com.liferay.portal.kernel.json.JSON;
021    import com.liferay.portal.kernel.util.GetterUtil;
022    import com.liferay.portal.kernel.util.ProxyUtil;
023    import com.liferay.portal.kernel.util.StringBundler;
024    import com.liferay.portal.kernel.util.StringPool;
025    import com.liferay.portal.model.CacheModel;
026    import com.liferay.portal.model.Portlet;
027    import com.liferay.portal.model.PortletModel;
028    import com.liferay.portal.model.PortletSoap;
029    import com.liferay.portal.service.ServiceContext;
030    
031    import com.liferay.portlet.expando.model.ExpandoBridge;
032    import com.liferay.portlet.expando.util.ExpandoBridgeFactoryUtil;
033    
034    import java.io.Serializable;
035    
036    import java.sql.Types;
037    
038    import java.util.ArrayList;
039    import java.util.HashMap;
040    import java.util.List;
041    import java.util.Map;
042    
043    /**
044     * The base model implementation for the Portlet service. Represents a row in the "Portlet" database table, with each column mapped to a property of this class.
045     *
046     * <p>
047     * This implementation and its corresponding interface {@link PortletModel} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link PortletImpl}.
048     * </p>
049     *
050     * @author Brian Wing Shun Chan
051     * @see PortletImpl
052     * @see Portlet
053     * @see PortletModel
054     * @generated
055     */
056    @JSON(strict = true)
057    @ProviderType
058    public class PortletModelImpl extends BaseModelImpl<Portlet>
059            implements PortletModel {
060            /*
061             * NOTE FOR DEVELOPERS:
062             *
063             * Never modify or reference this class directly. All methods that expect a portlet model instance should use the {@link Portlet} interface instead.
064             */
065            public static final String TABLE_NAME = "Portlet";
066            public static final Object[][] TABLE_COLUMNS = {
067                            { "mvccVersion", Types.BIGINT },
068                            { "id_", Types.BIGINT },
069                            { "companyId", Types.BIGINT },
070                            { "portletId", Types.VARCHAR },
071                            { "roles", Types.VARCHAR },
072                            { "active_", Types.BOOLEAN }
073                    };
074            public static final Map<String, Integer> TABLE_COLUMNS_MAP = new HashMap<String, Integer>();
075    
076            static {
077                    TABLE_COLUMNS_MAP.put("mvccVersion", Types.BIGINT);
078                    TABLE_COLUMNS_MAP.put("id_", Types.BIGINT);
079                    TABLE_COLUMNS_MAP.put("companyId", Types.BIGINT);
080                    TABLE_COLUMNS_MAP.put("portletId", Types.VARCHAR);
081                    TABLE_COLUMNS_MAP.put("roles", Types.VARCHAR);
082                    TABLE_COLUMNS_MAP.put("active_", Types.BOOLEAN);
083            }
084    
085            public static final String TABLE_SQL_CREATE = "create table Portlet (mvccVersion LONG default 0,id_ LONG not null primary key,companyId LONG,portletId VARCHAR(200) null,roles STRING null,active_ BOOLEAN)";
086            public static final String TABLE_SQL_DROP = "drop table Portlet";
087            public static final String ORDER_BY_JPQL = " ORDER BY portlet.id ASC";
088            public static final String ORDER_BY_SQL = " ORDER BY Portlet.id_ ASC";
089            public static final String DATA_SOURCE = "liferayDataSource";
090            public static final String SESSION_FACTORY = "liferaySessionFactory";
091            public static final String TX_MANAGER = "liferayTransactionManager";
092            public static final boolean ENTITY_CACHE_ENABLED = GetterUtil.getBoolean(com.liferay.portal.util.PropsUtil.get(
093                                    "value.object.entity.cache.enabled.com.liferay.portal.model.Portlet"),
094                            true);
095            public static final boolean FINDER_CACHE_ENABLED = GetterUtil.getBoolean(com.liferay.portal.util.PropsUtil.get(
096                                    "value.object.finder.cache.enabled.com.liferay.portal.model.Portlet"),
097                            true);
098            public static final boolean COLUMN_BITMASK_ENABLED = GetterUtil.getBoolean(com.liferay.portal.util.PropsUtil.get(
099                                    "value.object.column.bitmask.enabled.com.liferay.portal.model.Portlet"),
100                            true);
101            public static final long COMPANYID_COLUMN_BITMASK = 1L;
102            public static final long PORTLETID_COLUMN_BITMASK = 2L;
103            public static final long ID_COLUMN_BITMASK = 4L;
104    
105            /**
106             * Converts the soap model instance into a normal model instance.
107             *
108             * @param soapModel the soap model instance to convert
109             * @return the normal model instance
110             */
111            public static Portlet toModel(PortletSoap soapModel) {
112                    if (soapModel == null) {
113                            return null;
114                    }
115    
116                    Portlet model = new PortletImpl();
117    
118                    model.setMvccVersion(soapModel.getMvccVersion());
119                    model.setId(soapModel.getId());
120                    model.setCompanyId(soapModel.getCompanyId());
121                    model.setPortletId(soapModel.getPortletId());
122                    model.setRoles(soapModel.getRoles());
123                    model.setActive(soapModel.getActive());
124    
125                    return model;
126            }
127    
128            /**
129             * Converts the soap model instances into normal model instances.
130             *
131             * @param soapModels the soap model instances to convert
132             * @return the normal model instances
133             */
134            public static List<Portlet> toModels(PortletSoap[] soapModels) {
135                    if (soapModels == null) {
136                            return null;
137                    }
138    
139                    List<Portlet> models = new ArrayList<Portlet>(soapModels.length);
140    
141                    for (PortletSoap soapModel : soapModels) {
142                            models.add(toModel(soapModel));
143                    }
144    
145                    return models;
146            }
147    
148            public static final long LOCK_EXPIRATION_TIME = GetterUtil.getLong(com.liferay.portal.util.PropsUtil.get(
149                                    "lock.expiration.time.com.liferay.portal.model.Portlet"));
150    
151            public PortletModelImpl() {
152            }
153    
154            @Override
155            public long getPrimaryKey() {
156                    return _id;
157            }
158    
159            @Override
160            public void setPrimaryKey(long primaryKey) {
161                    setId(primaryKey);
162            }
163    
164            @Override
165            public Serializable getPrimaryKeyObj() {
166                    return _id;
167            }
168    
169            @Override
170            public void setPrimaryKeyObj(Serializable primaryKeyObj) {
171                    setPrimaryKey(((Long)primaryKeyObj).longValue());
172            }
173    
174            @Override
175            public Class<?> getModelClass() {
176                    return Portlet.class;
177            }
178    
179            @Override
180            public String getModelClassName() {
181                    return Portlet.class.getName();
182            }
183    
184            @Override
185            public Map<String, Object> getModelAttributes() {
186                    Map<String, Object> attributes = new HashMap<String, Object>();
187    
188                    attributes.put("mvccVersion", getMvccVersion());
189                    attributes.put("id", getId());
190                    attributes.put("companyId", getCompanyId());
191                    attributes.put("portletId", getPortletId());
192                    attributes.put("roles", getRoles());
193                    attributes.put("active", getActive());
194    
195                    attributes.put("entityCacheEnabled", isEntityCacheEnabled());
196                    attributes.put("finderCacheEnabled", isFinderCacheEnabled());
197    
198                    return attributes;
199            }
200    
201            @Override
202            public void setModelAttributes(Map<String, Object> attributes) {
203                    Long mvccVersion = (Long)attributes.get("mvccVersion");
204    
205                    if (mvccVersion != null) {
206                            setMvccVersion(mvccVersion);
207                    }
208    
209                    Long id = (Long)attributes.get("id");
210    
211                    if (id != null) {
212                            setId(id);
213                    }
214    
215                    Long companyId = (Long)attributes.get("companyId");
216    
217                    if (companyId != null) {
218                            setCompanyId(companyId);
219                    }
220    
221                    String portletId = (String)attributes.get("portletId");
222    
223                    if (portletId != null) {
224                            setPortletId(portletId);
225                    }
226    
227                    String roles = (String)attributes.get("roles");
228    
229                    if (roles != null) {
230                            setRoles(roles);
231                    }
232    
233                    Boolean active = (Boolean)attributes.get("active");
234    
235                    if (active != null) {
236                            setActive(active);
237                    }
238            }
239    
240            @JSON
241            @Override
242            public long getMvccVersion() {
243                    return _mvccVersion;
244            }
245    
246            @Override
247            public void setMvccVersion(long mvccVersion) {
248                    _mvccVersion = mvccVersion;
249            }
250    
251            @JSON
252            @Override
253            public long getId() {
254                    return _id;
255            }
256    
257            @Override
258            public void setId(long id) {
259                    _id = id;
260            }
261    
262            @JSON
263            @Override
264            public long getCompanyId() {
265                    return _companyId;
266            }
267    
268            @Override
269            public void setCompanyId(long companyId) {
270                    _columnBitmask |= COMPANYID_COLUMN_BITMASK;
271    
272                    if (!_setOriginalCompanyId) {
273                            _setOriginalCompanyId = true;
274    
275                            _originalCompanyId = _companyId;
276                    }
277    
278                    _companyId = companyId;
279            }
280    
281            public long getOriginalCompanyId() {
282                    return _originalCompanyId;
283            }
284    
285            @JSON
286            @Override
287            public String getPortletId() {
288                    if (_portletId == null) {
289                            return StringPool.BLANK;
290                    }
291                    else {
292                            return _portletId;
293                    }
294            }
295    
296            @Override
297            public void setPortletId(String portletId) {
298                    _columnBitmask |= PORTLETID_COLUMN_BITMASK;
299    
300                    if (_originalPortletId == null) {
301                            _originalPortletId = _portletId;
302                    }
303    
304                    _portletId = portletId;
305            }
306    
307            public String getOriginalPortletId() {
308                    return GetterUtil.getString(_originalPortletId);
309            }
310    
311            @JSON
312            @Override
313            public String getRoles() {
314                    if (_roles == null) {
315                            return StringPool.BLANK;
316                    }
317                    else {
318                            return _roles;
319                    }
320            }
321    
322            @Override
323            public void setRoles(String roles) {
324                    _roles = roles;
325            }
326    
327            @JSON
328            @Override
329            public boolean getActive() {
330                    return _active;
331            }
332    
333            @Override
334            public boolean isActive() {
335                    return _active;
336            }
337    
338            @Override
339            public void setActive(boolean active) {
340                    _active = active;
341            }
342    
343            public long getColumnBitmask() {
344                    return _columnBitmask;
345            }
346    
347            @Override
348            public ExpandoBridge getExpandoBridge() {
349                    return ExpandoBridgeFactoryUtil.getExpandoBridge(getCompanyId(),
350                            Portlet.class.getName(), getPrimaryKey());
351            }
352    
353            @Override
354            public void setExpandoBridgeAttributes(ServiceContext serviceContext) {
355                    ExpandoBridge expandoBridge = getExpandoBridge();
356    
357                    expandoBridge.setAttributes(serviceContext);
358            }
359    
360            @Override
361            public Portlet toEscapedModel() {
362                    if (_escapedModel == null) {
363                            _escapedModel = (Portlet)ProxyUtil.newProxyInstance(_classLoader,
364                                            _escapedModelInterfaces, new AutoEscapeBeanHandler(this));
365                    }
366    
367                    return _escapedModel;
368            }
369    
370            @Override
371            public Object clone() {
372                    PortletImpl portletImpl = new PortletImpl();
373    
374                    portletImpl.setMvccVersion(getMvccVersion());
375                    portletImpl.setId(getId());
376                    portletImpl.setCompanyId(getCompanyId());
377                    portletImpl.setPortletId(getPortletId());
378                    portletImpl.setRoles(getRoles());
379                    portletImpl.setActive(getActive());
380    
381                    portletImpl.resetOriginalValues();
382    
383                    return portletImpl;
384            }
385    
386            @Override
387            public int compareTo(Portlet portlet) {
388                    long primaryKey = portlet.getPrimaryKey();
389    
390                    if (getPrimaryKey() < primaryKey) {
391                            return -1;
392                    }
393                    else if (getPrimaryKey() > primaryKey) {
394                            return 1;
395                    }
396                    else {
397                            return 0;
398                    }
399            }
400    
401            @Override
402            public boolean equals(Object obj) {
403                    if (this == obj) {
404                            return true;
405                    }
406    
407                    if (!(obj instanceof Portlet)) {
408                            return false;
409                    }
410    
411                    Portlet portlet = (Portlet)obj;
412    
413                    long primaryKey = portlet.getPrimaryKey();
414    
415                    if (getPrimaryKey() == primaryKey) {
416                            return true;
417                    }
418                    else {
419                            return false;
420                    }
421            }
422    
423            @Override
424            public int hashCode() {
425                    return (int)getPrimaryKey();
426            }
427    
428            @Override
429            public boolean isEntityCacheEnabled() {
430                    return ENTITY_CACHE_ENABLED;
431            }
432    
433            @Override
434            public boolean isFinderCacheEnabled() {
435                    return FINDER_CACHE_ENABLED;
436            }
437    
438            @Override
439            public void resetOriginalValues() {
440                    PortletModelImpl portletModelImpl = this;
441    
442                    portletModelImpl._originalCompanyId = portletModelImpl._companyId;
443    
444                    portletModelImpl._setOriginalCompanyId = false;
445    
446                    portletModelImpl._originalPortletId = portletModelImpl._portletId;
447    
448                    portletModelImpl._columnBitmask = 0;
449            }
450    
451            @Override
452            public CacheModel<Portlet> toCacheModel() {
453                    PortletCacheModel portletCacheModel = new PortletCacheModel();
454    
455                    portletCacheModel.mvccVersion = getMvccVersion();
456    
457                    portletCacheModel.id = getId();
458    
459                    portletCacheModel.companyId = getCompanyId();
460    
461                    portletCacheModel.portletId = getPortletId();
462    
463                    String portletId = portletCacheModel.portletId;
464    
465                    if ((portletId != null) && (portletId.length() == 0)) {
466                            portletCacheModel.portletId = null;
467                    }
468    
469                    portletCacheModel.roles = getRoles();
470    
471                    String roles = portletCacheModel.roles;
472    
473                    if ((roles != null) && (roles.length() == 0)) {
474                            portletCacheModel.roles = null;
475                    }
476    
477                    portletCacheModel.active = getActive();
478    
479                    return portletCacheModel;
480            }
481    
482            @Override
483            public String toString() {
484                    StringBundler sb = new StringBundler(13);
485    
486                    sb.append("{mvccVersion=");
487                    sb.append(getMvccVersion());
488                    sb.append(", id=");
489                    sb.append(getId());
490                    sb.append(", companyId=");
491                    sb.append(getCompanyId());
492                    sb.append(", portletId=");
493                    sb.append(getPortletId());
494                    sb.append(", roles=");
495                    sb.append(getRoles());
496                    sb.append(", active=");
497                    sb.append(getActive());
498                    sb.append("}");
499    
500                    return sb.toString();
501            }
502    
503            @Override
504            public String toXmlString() {
505                    StringBundler sb = new StringBundler(22);
506    
507                    sb.append("<model><model-name>");
508                    sb.append("com.liferay.portal.model.Portlet");
509                    sb.append("</model-name>");
510    
511                    sb.append(
512                            "<column><column-name>mvccVersion</column-name><column-value><![CDATA[");
513                    sb.append(getMvccVersion());
514                    sb.append("]]></column-value></column>");
515                    sb.append(
516                            "<column><column-name>id</column-name><column-value><![CDATA[");
517                    sb.append(getId());
518                    sb.append("]]></column-value></column>");
519                    sb.append(
520                            "<column><column-name>companyId</column-name><column-value><![CDATA[");
521                    sb.append(getCompanyId());
522                    sb.append("]]></column-value></column>");
523                    sb.append(
524                            "<column><column-name>portletId</column-name><column-value><![CDATA[");
525                    sb.append(getPortletId());
526                    sb.append("]]></column-value></column>");
527                    sb.append(
528                            "<column><column-name>roles</column-name><column-value><![CDATA[");
529                    sb.append(getRoles());
530                    sb.append("]]></column-value></column>");
531                    sb.append(
532                            "<column><column-name>active</column-name><column-value><![CDATA[");
533                    sb.append(getActive());
534                    sb.append("]]></column-value></column>");
535    
536                    sb.append("</model>");
537    
538                    return sb.toString();
539            }
540    
541            private static final ClassLoader _classLoader = Portlet.class.getClassLoader();
542            private static final Class<?>[] _escapedModelInterfaces = new Class[] {
543                            Portlet.class
544                    };
545            private long _mvccVersion;
546            private long _id;
547            private long _companyId;
548            private long _originalCompanyId;
549            private boolean _setOriginalCompanyId;
550            private String _portletId;
551            private String _originalPortletId;
552            private String _roles;
553            private boolean _active;
554            private long _columnBitmask;
555            private Portlet _escapedModel;
556    }