001/**
002 * Copyright (C) 2006-2021 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.configuration.ui.widget;
017
018import static java.lang.annotation.ElementType.FIELD;
019import static java.lang.annotation.ElementType.PARAMETER;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025import org.talend.sdk.component.api.configuration.action.meta.ActionRef;
026import org.talend.sdk.component.api.configuration.ui.meta.Ui;
027import org.talend.sdk.component.api.meta.Documentation;
028import org.talend.sdk.component.api.service.schema.DiscoverSchema;
029
030@Ui
031@ActionRef(value = DiscoverSchema.class, ref = "discoverSchema")
032@Documentation("Mark a List<String> or List<Object> field as being represented as the component data selector.")
033@Retention(RUNTIME)
034@Target({ PARAMETER, FIELD })
035public @interface Structure {
036
037    /**
038     * @return the name of the input/output.
039     */
040    String value() default "__default__";
041
042    /**
043     * @return an optional discover schema reference.
044     */
045    String discoverSchema() default "";
046
047    /**
048     * @return type of connection the field modelises.
049     */
050    Type type() default Type.IN;
051
052    enum Type {
053        IN,
054        OUT
055    }
056}