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 com.liferay.portal.model.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 com.liferay.portal.model.Portlet
053     * @see com.liferay.portal.model.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 com.liferay.portal.model.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 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)";
075            public static final String TABLE_SQL_DROP = "drop table Portlet";
076            public static final String ORDER_BY_JPQL = " ORDER BY portlet.id ASC";
077            public static final String ORDER_BY_SQL = " ORDER BY Portlet.id_ ASC";
078            public static final String DATA_SOURCE = "liferayDataSource";
079            public static final String SESSION_FACTORY = "liferaySessionFactory";
080            public static final String TX_MANAGER = "liferayTransactionManager";
081            public static final boolean ENTITY_CACHE_ENABLED = GetterUtil.getBoolean(com.liferay.portal.util.PropsUtil.get(
082                                    "value.object.entity.cache.enabled.com.liferay.portal.model.Portlet"),
083                            true);
084            public static final boolean FINDER_CACHE_ENABLED = GetterUtil.getBoolean(com.liferay.portal.util.PropsUtil.get(
085                                    "value.object.finder.cache.enabled.com.liferay.portal.model.Portlet"),
086                            true);
087            public static final boolean COLUMN_BITMASK_ENABLED = GetterUtil.getBoolean(com.liferay.portal.util.PropsUtil.get(
088                                    "value.object.column.bitmask.enabled.com.liferay.portal.model.Portlet"),
089                            true);
090            public static final long COMPANYID_COLUMN_BITMASK = 1L;
091            public static final long PORTLETID_COLUMN_BITMASK = 2L;
092            public static final long ID_COLUMN_BITMASK = 4L;
093    
094            /**
095             * Converts the soap model instance into a normal model instance.
096             *
097             * @param soapModel the soap model instance to convert
098             * @return the normal model instance
099             */
100            public static Portlet toModel(PortletSoap soapModel) {
101                    if (soapModel == null) {
102                            return null;
103                    }
104    
105                    Portlet model = new PortletImpl();
106    
107                    model.setMvccVersion(soapModel.getMvccVersion());
108                    model.setId(soapModel.getId());
109                    model.setCompanyId(soapModel.getCompanyId());
110                    model.setPortletId(soapModel.getPortletId());
111                    model.setRoles(soapModel.getRoles());
112                    model.setActive(soapModel.getActive());
113    
114                    return model;
115            }
116    
117            /**
118             * Converts the soap model instances into normal model instances.
119             *
120             * @param soapModels the soap model instances to convert
121             * @return the normal model instances
122             */
123            public static List<Portlet> toModels(PortletSoap[] soapModels) {
124                    if (soapModels == null) {
125                            return null;
126                    }
127    
128                    List<Portlet> models = new ArrayList<Portlet>(soapModels.length);
129    
130                    for (PortletSoap soapModel : soapModels) {
131                            models.add(toModel(soapModel));
132                    }
133    
134                    return models;
135            }
136    
137            public static final long LOCK_EXPIRATION_TIME = GetterUtil.getLong(com.liferay.portal.util.PropsUtil.get(
138                                    "lock.expiration.time.com.liferay.portal.model.Portlet"));
139    
140            public PortletModelImpl() {
141            }
142    
143            @Override
144            public long getPrimaryKey() {
145                    return _id;
146            }
147    
148            @Override
149            public void setPrimaryKey(long primaryKey) {
150                    setId(primaryKey);
151            }
152    
153            @Override
154            public Serializable getPrimaryKeyObj() {
155                    return _id;
156            }
157    
158            @Override
159            public void setPrimaryKeyObj(Serializable primaryKeyObj) {
160                    setPrimaryKey(((Long)primaryKeyObj).longValue());
161            }
162    
163            @Override
164            public Class<?> getModelClass() {
165                    return Portlet.class;
166            }
167    
168            @Override
169            public String getModelClassName() {
170                    return Portlet.class.getName();
171            }
172    
173            @Override
174            public Map<String, Object> getModelAttributes() {
175                    Map<String, Object> attributes = new HashMap<String, Object>();
176    
177                    attributes.put("mvccVersion", getMvccVersion());
178                    attributes.put("id", getId());
179                    attributes.put("companyId", getCompanyId());
180                    attributes.put("portletId", getPortletId());
181                    attributes.put("roles", getRoles());
182                    attributes.put("active", getActive());
183    
184                    attributes.put("entityCacheEnabled", isEntityCacheEnabled());
185                    attributes.put("finderCacheEnabled", isFinderCacheEnabled());
186    
187                    return attributes;
188            }
189    
190            @Override
191            public void setModelAttributes(Map<String, Object> attributes) {
192                    Long mvccVersion = (Long)attributes.get("mvccVersion");
193    
194                    if (mvccVersion != null) {
195                            setMvccVersion(mvccVersion);
196                    }
197    
198                    Long id = (Long)attributes.get("id");
199    
200                    if (id != null) {
201                            setId(id);
202                    }
203    
204                    Long companyId = (Long)attributes.get("companyId");
205    
206                    if (companyId != null) {
207                            setCompanyId(companyId);
208                    }
209    
210                    String portletId = (String)attributes.get("portletId");
211    
212                    if (portletId != null) {
213                            setPortletId(portletId);
214                    }
215    
216                    String roles = (String)attributes.get("roles");
217    
218                    if (roles != null) {
219                            setRoles(roles);
220                    }
221    
222                    Boolean active = (Boolean)attributes.get("active");
223    
224                    if (active != null) {
225                            setActive(active);
226                    }
227            }
228    
229            @JSON
230            @Override
231            public long getMvccVersion() {
232                    return _mvccVersion;
233            }
234    
235            @Override
236            public void setMvccVersion(long mvccVersion) {
237                    _mvccVersion = mvccVersion;
238            }
239    
240            @JSON
241            @Override
242            public long getId() {
243                    return _id;
244            }
245    
246            @Override
247            public void setId(long id) {
248                    _id = id;
249            }
250    
251            @JSON
252            @Override
253            public long getCompanyId() {
254                    return _companyId;
255            }
256    
257            @Override
258            public void setCompanyId(long companyId) {
259                    _columnBitmask |= COMPANYID_COLUMN_BITMASK;
260    
261                    if (!_setOriginalCompanyId) {
262                            _setOriginalCompanyId = true;
263    
264                            _originalCompanyId = _companyId;
265                    }
266    
267                    _companyId = companyId;
268            }
269    
270            public long getOriginalCompanyId() {
271                    return _originalCompanyId;
272            }
273    
274            @JSON
275            @Override
276            public String getPortletId() {
277                    if (_portletId == null) {
278                            return StringPool.BLANK;
279                    }
280                    else {
281                            return _portletId;
282                    }
283            }
284    
285            @Override
286            public void setPortletId(String portletId) {
287                    _columnBitmask |= PORTLETID_COLUMN_BITMASK;
288    
289                    if (_originalPortletId == null) {
290                            _originalPortletId = _portletId;
291                    }
292    
293                    _portletId = portletId;
294            }
295    
296            public String getOriginalPortletId() {
297                    return GetterUtil.getString(_originalPortletId);
298            }
299    
300            @JSON
301            @Override
302            public String getRoles() {
303                    if (_roles == null) {
304                            return StringPool.BLANK;
305                    }
306                    else {
307                            return _roles;
308                    }
309            }
310    
311            @Override
312            public void setRoles(String roles) {
313                    _roles = roles;
314            }
315    
316            @JSON
317            @Override
318            public boolean getActive() {
319                    return _active;
320            }
321    
322            @Override
323            public boolean isActive() {
324                    return _active;
325            }
326    
327            @Override
328            public void setActive(boolean active) {
329                    _active = active;
330            }
331    
332            public long getColumnBitmask() {
333                    return _columnBitmask;
334            }
335    
336            @Override
337            public ExpandoBridge getExpandoBridge() {
338                    return ExpandoBridgeFactoryUtil.getExpandoBridge(getCompanyId(),
339                            Portlet.class.getName(), getPrimaryKey());
340            }
341    
342            @Override
343            public void setExpandoBridgeAttributes(ServiceContext serviceContext) {
344                    ExpandoBridge expandoBridge = getExpandoBridge();
345    
346                    expandoBridge.setAttributes(serviceContext);
347            }
348    
349            @Override
350            public Portlet toEscapedModel() {
351                    if (_escapedModel == null) {
352                            _escapedModel = (Portlet)ProxyUtil.newProxyInstance(_classLoader,
353                                            _escapedModelInterfaces, new AutoEscapeBeanHandler(this));
354                    }
355    
356                    return _escapedModel;
357            }
358    
359            @Override
360            public Object clone() {
361                    PortletImpl portletImpl = new PortletImpl();
362    
363                    portletImpl.setMvccVersion(getMvccVersion());
364                    portletImpl.setId(getId());
365                    portletImpl.setCompanyId(getCompanyId());
366                    portletImpl.setPortletId(getPortletId());
367                    portletImpl.setRoles(getRoles());
368                    portletImpl.setActive(getActive());
369    
370                    portletImpl.resetOriginalValues();
371    
372                    return portletImpl;
373            }
374    
375            @Override
376            public int compareTo(Portlet portlet) {
377                    long primaryKey = portlet.getPrimaryKey();
378    
379                    if (getPrimaryKey() < primaryKey) {
380                            return -1;
381                    }
382                    else if (getPrimaryKey() > primaryKey) {
383                            return 1;
384                    }
385                    else {
386                            return 0;
387                    }
388            }
389    
390            @Override
391            public boolean equals(Object obj) {
392                    if (this == obj) {
393                            return true;
394                    }
395    
396                    if (!(obj instanceof Portlet)) {
397                            return false;
398                    }
399    
400                    Portlet portlet = (Portlet)obj;
401    
402                    long primaryKey = portlet.getPrimaryKey();
403    
404                    if (getPrimaryKey() == primaryKey) {
405                            return true;
406                    }
407                    else {
408                            return false;
409                    }
410            }
411    
412            @Override
413            public int hashCode() {
414                    return (int)getPrimaryKey();
415            }
416    
417            @Override
418            public boolean isEntityCacheEnabled() {
419                    return ENTITY_CACHE_ENABLED;
420            }
421    
422            @Override
423            public boolean isFinderCacheEnabled() {
424                    return FINDER_CACHE_ENABLED;
425            }
426    
427            @Override
428            public void resetOriginalValues() {
429                    PortletModelImpl portletModelImpl = this;
430    
431                    portletModelImpl._originalCompanyId = portletModelImpl._companyId;
432    
433                    portletModelImpl._setOriginalCompanyId = false;
434    
435                    portletModelImpl._originalPortletId = portletModelImpl._portletId;
436    
437                    portletModelImpl._columnBitmask = 0;
438            }
439    
440            @Override
441            public CacheModel<Portlet> toCacheModel() {
442                    PortletCacheModel portletCacheModel = new PortletCacheModel();
443    
444                    portletCacheModel.mvccVersion = getMvccVersion();
445    
446                    portletCacheModel.id = getId();
447    
448                    portletCacheModel.companyId = getCompanyId();
449    
450                    portletCacheModel.portletId = getPortletId();
451    
452                    String portletId = portletCacheModel.portletId;
453    
454                    if ((portletId != null) && (portletId.length() == 0)) {
455                            portletCacheModel.portletId = null;
456                    }
457    
458                    portletCacheModel.roles = getRoles();
459    
460                    String roles = portletCacheModel.roles;
461    
462                    if ((roles != null) && (roles.length() == 0)) {
463                            portletCacheModel.roles = null;
464                    }
465    
466                    portletCacheModel.active = getActive();
467    
468                    return portletCacheModel;
469            }
470    
471            @Override
472            public String toString() {
473                    StringBundler sb = new StringBundler(13);
474    
475                    sb.append("{mvccVersion=");
476                    sb.append(getMvccVersion());
477                    sb.append(", id=");
478                    sb.append(getId());
479                    sb.append(", companyId=");
480                    sb.append(getCompanyId());
481                    sb.append(", portletId=");
482                    sb.append(getPortletId());
483                    sb.append(", roles=");
484                    sb.append(getRoles());
485                    sb.append(", active=");
486                    sb.append(getActive());
487                    sb.append("}");
488    
489                    return sb.toString();
490            }
491    
492            @Override
493            public String toXmlString() {
494                    StringBundler sb = new StringBundler(22);
495    
496                    sb.append("<model><model-name>");
497                    sb.append("com.liferay.portal.model.Portlet");
498                    sb.append("</model-name>");
499    
500                    sb.append(
501                            "<column><column-name>mvccVersion</column-name><column-value><![CDATA[");
502                    sb.append(getMvccVersion());
503                    sb.append("]]></column-value></column>");
504                    sb.append(
505                            "<column><column-name>id</column-name><column-value><![CDATA[");
506                    sb.append(getId());
507                    sb.append("]]></column-value></column>");
508                    sb.append(
509                            "<column><column-name>companyId</column-name><column-value><![CDATA[");
510                    sb.append(getCompanyId());
511                    sb.append("]]></column-value></column>");
512                    sb.append(
513                            "<column><column-name>portletId</column-name><column-value><![CDATA[");
514                    sb.append(getPortletId());
515                    sb.append("]]></column-value></column>");
516                    sb.append(
517                            "<column><column-name>roles</column-name><column-value><![CDATA[");
518                    sb.append(getRoles());
519                    sb.append("]]></column-value></column>");
520                    sb.append(
521                            "<column><column-name>active</column-name><column-value><![CDATA[");
522                    sb.append(getActive());
523                    sb.append("]]></column-value></column>");
524    
525                    sb.append("</model>");
526    
527                    return sb.toString();
528            }
529    
530            private static final ClassLoader _classLoader = Portlet.class.getClassLoader();
531            private static final Class<?>[] _escapedModelInterfaces = new Class[] {
532                            Portlet.class
533                    };
534            private long _mvccVersion;
535            private long _id;
536            private long _companyId;
537            private long _originalCompanyId;
538            private boolean _setOriginalCompanyId;
539            private String _portletId;
540            private String _originalPortletId;
541            private String _roles;
542            private boolean _active;
543            private long _columnBitmask;
544            private Portlet _escapedModel;
545    }