001/*
002 * (C) Copyright 2006-2010 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     bstefanescu
016 */
017package org.nuxeo.shell.automation.cmds;
018
019import org.nuxeo.ecm.automation.client.model.DocRef;
020import org.nuxeo.ecm.automation.client.model.Document;
021import org.nuxeo.shell.Argument;
022import org.nuxeo.shell.Command;
023import org.nuxeo.shell.Context;
024import org.nuxeo.shell.Parameter;
025import org.nuxeo.shell.ShellConsole;
026import org.nuxeo.shell.ShellException;
027import org.nuxeo.shell.automation.DocRefCompletor;
028import org.nuxeo.shell.automation.DocumentHelper;
029import org.nuxeo.shell.automation.RemoteContext;
030
031/**
032 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
033 */
034@Command(name = "ls", help = "List children documents")
035public class Ls implements Runnable {
036
037    @Context
038    protected RemoteContext ctx;
039
040    @Argument(name = "doc", index = 0, required = false, completor = DocRefCompletor.class, help = "A document to list its content. If not specified list the current document content. To use UID references prefix them with 'doc:'.")
041    protected DocRef root;
042
043    @Parameter(name = "-uid", hasValue = false, help = "If used the documents will be printed using the document UID.")
044    protected boolean uid = false;
045
046    @Parameter(name = "-title", hasValue = false, help = "If used the documents will be printed using their dublincore title.")
047    protected boolean title = false;
048
049    public void run() {
050        ShellConsole console = ctx.getShell().getConsole();
051        if (root == null) {
052            // get the current document if target doc was not specified.
053            root = ctx.getDocument();
054        }
055        try {
056            for (Document doc : ctx.getDocumentService().getChildren(root)) {
057                if (uid) {
058                    console.println(doc.getId());
059                } else if (title) {
060                    console.println(doc.getTitle());
061                } else {
062                    DocumentHelper.printName(console, doc);
063                }
064            }
065        } catch (Exception e) {
066            throw new ShellException("Failed to list document " + root, e);
067        }
068
069    }
070}