AggregateRuntimeFieldNameGenerator.java

/*******************************************************************************
 * Copyright (c) 1998, 2015 Oracle and/or its affiliates. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation from Oracle TopLink
******************************************************************************/
package org.eclipse.persistence.tools.workbench.mappingsmodel.mapping.relational;

import org.eclipse.persistence.tools.workbench.mappingsmodel.descriptor.MWDescriptor;

public interface AggregateRuntimeFieldNameGenerator {

    /**
     * used for specifying unique field names inside the aggregate descriptor
     * and matching up with field translations in the aggregateObjectMapping
     * This will be persisted and used to create a runtime project
     */
    String fieldNameForRuntime();

    /**
     * A description of the field that will be used in the UI
     */
    AggregateFieldDescription fullFieldDescription();

    /**
     * Return true if this field will be written by toplink.
     * For example a 1-1 target foreign key would return false.
     */
    boolean fieldIsWritten();

    /**
     * Return the generator's owning" descriptor.
     * This is used to build an AggregatePathToColumn's description.
     */
    MWDescriptor owningDescriptor();

}