org.neo4j.shell.kernel.apps.Mv Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-shell Show documentation
A generic command shell with a client and server part.
There is a newer version: 3.3.2
/*
 * Copyright (c) 2002-2016 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.shell.kernel.apps;

import org.neo4j.helpers.Service;
import org.neo4j.shell.App;
import org.neo4j.shell.AppCommandParser;
import org.neo4j.shell.Continuation;
import org.neo4j.shell.OptionDefinition;
import org.neo4j.shell.OptionValueType;
import org.neo4j.shell.Output;
import org.neo4j.shell.Session;
import org.neo4j.shell.ShellException;

/**
 * Mimics the POSIX application with the same name, i.e. renames a property. It
 * could also (regarding POSIX) move nodes, but it doesn't).
 */
@Service.Implementation( App.class )
public class Mv extends TransactionProvidingApp
{
    /**
     * Constructs a new "mv" application.
     */
    public Mv()
    {
        super();
        this.addOptionDefinition( "o", new OptionDefinition( OptionValueType.NONE,
            "To override if the key already exists" ) );
    }

    @Override
    public String getDescription()
    {
        return "Renames a property on a node or relationship. " +
            "Usage: mv  ";
    }

    @Override
    protected Continuation exec( AppCommandParser parser, Session session, Output out )
        throws ShellException
    {
        if ( parser.arguments().size() < 2 )
        {
            throw new ShellException( "Must supply   " +
                "arguments, like: mv name \"given_name\"" );
        }
        String fromKey = parser.arguments().get( 0 );
        String toKey = parser.arguments().get( 1 );
        boolean mayOverwrite = parser.options().containsKey( "o" );
        NodeOrRelationship thing = getCurrent( session );
        if ( !thing.hasProperty( fromKey ) )
        {
            throw new ShellException( "Property '" + fromKey +
                "' doesn't exist" );
        }
        if ( thing.hasProperty( toKey ) )
        {
            if ( !mayOverwrite )
            {
                throw new ShellException( "Property '" + toKey +
                    "' already exists, supply -o flag to overwrite" );
            }
            else
            {
                thing.removeProperty( toKey );
            }
        }

        Object value = thing.removeProperty( fromKey );
        thing.setProperty( toKey, value );
        return Continuation.INPUT_COMPLETE;
    }
}