001/*
002 * (C) Copyright 2006-2007 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 *     <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
016 *
017 * $Id: FieldDescriptor.java 28478 2008-01-04 12:53:58Z sfermigier $
018 */
019
020package org.nuxeo.ecm.platform.forms.layout.descriptors;
021
022import org.nuxeo.common.xmap.annotation.XNode;
023import org.nuxeo.common.xmap.annotation.XObject;
024import org.nuxeo.ecm.platform.forms.layout.api.FieldDefinition;
025import org.nuxeo.ecm.platform.forms.layout.api.impl.FieldDefinitionImpl;
026
027/**
028 * Field definition descriptor.
029 *
030 * @author <a href="mailto:at@nuxeo.com">Anahide Tchertchian</a>
031 */
032@XObject("field")
033public class FieldDescriptor {
034
035    @XNode("@schema")
036    String schema;
037
038    @XNode("")
039    String field;
040
041    public FieldDescriptor() {
042    }
043
044    public FieldDescriptor(String schema, String field) {
045        this.schema = schema;
046        this.field = field;
047    }
048
049    public String getSchemaName() {
050        return schema;
051    }
052
053    public String getFieldName() {
054        return field;
055    }
056
057    public String getPropertyName() {
058        if (schema == null || schema.length() == 0) {
059            return field;
060        } else {
061            return String.format("%s:%s", schema, field);
062        }
063    }
064
065    public FieldDefinition getFieldDefinition() {
066        return new FieldDefinitionImpl(schema, field);
067    }
068
069}