001/*
002 * Copyright (c) 2016-2017 Chris K Wensel <chris@wensel.net>. All Rights Reserved.
003 *
004 * Project and contact information: http://www.cascading.org/
005 *
006 * This file is part of the Cascading project.
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020
021package cascading.nested.json;
022
023import java.beans.ConstructorProperties;
024import java.util.Map;
025
026import cascading.nested.core.NestedGetFunction;
027import cascading.tuple.Fields;
028import com.fasterxml.jackson.databind.JsonNode;
029import com.fasterxml.jackson.databind.node.ArrayNode;
030
031/**
032 * Class JSONGetFunction provides for the ability to convert a JSON object into multiple tuple values.
033 *
034 * @see NestedGetFunction for more details.
035 */
036public class JSONGetFunction extends NestedGetFunction<JsonNode, ArrayNode>
037  {
038  /**
039   * Creates a new JSONGetFunction instance.
040   *
041   * @param pointerMap of Map
042   */
043  @ConstructorProperties("pointerMap")
044  public JSONGetFunction( Map<Fields, String> pointerMap )
045    {
046    this( asFields( pointerMap.keySet() ), asArray( pointerMap.values() ) );
047    }
048
049  /**
050   * Creates a new JSONGetFunction instance.
051   *
052   * @param pointerMap        of Map
053   * @param failOnMissingNode of boolean
054   */
055  @ConstructorProperties({"pointerMap", "failOnMissingNode"})
056  public JSONGetFunction( Map<Fields, String> pointerMap, boolean failOnMissingNode )
057    {
058    this( asFields( pointerMap.keySet() ), failOnMissingNode, asArray( pointerMap.values() ) );
059    }
060
061  /**
062   * Creates a new JSONGetFunction instance.
063   *
064   * @param fieldDeclaration of Fields
065   * @param stringPointers   of String...
066   */
067  @ConstructorProperties({"fieldDeclaration", "stringPointers"})
068  public JSONGetFunction( Fields fieldDeclaration, String... stringPointers )
069    {
070    this( fieldDeclaration, false, stringPointers );
071    }
072
073  /**
074   * Creates a new JSONGetFunction instance.
075   *
076   * @param fieldDeclaration  of Fields
077   * @param failOnMissingNode of boolean
078   * @param stringPointers    of String...
079   */
080  @ConstructorProperties({"fieldDeclaration", "failOnMissingNode", "stringPointers"})
081  public JSONGetFunction( Fields fieldDeclaration, boolean failOnMissingNode, String... stringPointers )
082    {
083    super( JSONCoercibleType.TYPE, fieldDeclaration, failOnMissingNode, stringPointers );
084    }
085  }