org.xwiki.platform.patchservice.impl.ObjectPropertyDeleteAtOperation.java Source code

Introduction

Here is the source code for org.xwiki.platform.patchservice.impl.ObjectPropertyDeleteAtOperation.java

Source

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 *
 */
package org.xwiki.platform.patchservice.impl;

import java.util.Formatter;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xwiki.platform.patchservice.api.Operation;
import org.xwiki.platform.patchservice.api.Position;
import org.xwiki.platform.patchservice.api.RWOperation;

import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.objects.BaseObject;

public class ObjectPropertyDeleteAtOperation extends AbstractOperationImpl implements RWOperation {
    private String className;

    private int number = -1;

    private String propertyName;

    private Position position;

    private String deletedContent;

    static {
        OperationFactoryImpl.registerTypeProvider(Operation.TYPE_OBJECT_PROPERTY_DELETE_AT,
                ObjectPropertyDeleteAtOperation.class);
    }

    public ObjectPropertyDeleteAtOperation() {
        this.setType(Operation.TYPE_OBJECT_PROPERTY_DELETE_AT);
    }

    /**
     * {@inheritDoc}
     */
    public void apply(XWikiDocument doc, XWikiContext context) throws XWikiException {
        BaseObject obj = doc.getObject(this.className, this.number);
        if (obj == null) {
            throw new XWikiException(XWikiException.MODULE_XWIKI_PLUGINS, XWikiException.ERROR_XWIKI_UNKNOWN,
                    new Formatter().format("Invalid object type/number: %s[%d]",
                            new Object[] { this.className, new Integer(this.number) }).toString());
        }
        try {
            String value = obj.getLargeStringValue(this.propertyName);
            if (!this.position.checkPosition(value)
                    || !this.position.getTextAfterPosition(value).startsWith(this.deletedContent)) {
                throw new Exception();
            }
            value = this.position.getTextBeforePosition(value) + StringUtils
                    .substring(this.position.getTextAfterPosition(value), this.deletedContent.length());
            obj.set(this.propertyName, value, context);
        } catch (Exception e) {
            throw new XWikiException(XWikiException.MODULE_XWIKI_PLUGINS, XWikiException.ERROR_XWIKI_UNKNOWN,
                    new Formatter().format("Invalid deleted text: [%s] for object property [%s]",
                            new Object[] { this.deletedContent, this.propertyName }).toString());
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean deleteFromProperty(String objectClass, int index, String propertyName, String value,
            Position position) {
        this.className = objectClass;
        this.number = index;
        this.propertyName = propertyName;
        this.deletedContent = value;
        this.position = position;
        return true;
    }

    /**
     * {@inheritDoc}
     */
    public void fromXml(Element e) throws XWikiException {
        this.className = getObjectClassname(e);
        this.number = getObjectNumber(e);
        this.propertyName = getPropertyName(getObjectNode(e));
        this.deletedContent = getTextValue(e);
        this.position = loadPositionNode(e);
    }

    /**
     * {@inheritDoc}
     */
    public Element toXml(Document doc) throws XWikiException {
        Element xmlNode = createOperationNode(doc);
        Element objectNode = createObjectNode(this.className, this.number, doc);
        objectNode.appendChild(createPropertyNode(this.propertyName, doc));
        xmlNode.appendChild(objectNode);
        xmlNode.appendChild(createTextNode(this.deletedContent, doc));
        xmlNode.appendChild(this.position.toXml(doc));
        return xmlNode;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object other) {
        try {
            ObjectPropertyDeleteAtOperation that = (ObjectPropertyDeleteAtOperation) other;
            return that.getType().equals(this.getType()) && that.className.equals(this.className)
                    && (that.number == this.number) && that.propertyName.equals(this.propertyName)
                    && that.deletedContent.equals(this.deletedContent) && that.position.equals(this.position);
        } catch (Exception e) {
            return false;
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        return new HashCodeBuilder(31, 37).append(this.className).append(this.number).append(this.propertyName)
                .append(this.deletedContent).append(this.position).toHashCode();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return getType() + ": [" + this.className + "[" + this.number + "]#" + this.propertyName + "]@"
                + this.position + " = [" + this.deletedContent + "]";
    }
}