# -*- coding: utf-8 -*-

###############################################################################
#
# FindSubstring
# Finds all occurrences of a specified substring and returns the substring positions as a JSON array.
#
# Python versions 2.6, 2.7, 3.x
#
# Copyright 2014, Temboo Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
# either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
#
#
###############################################################################

from temboo.core.choreography import Choreography
from temboo.core.choreography import InputSet
from temboo.core.choreography import ResultSet
from temboo.core.choreography import ChoreographyExecution

import json

class FindSubstring(Choreography):

    def __init__(self, temboo_session):
        """
        Create a new instance of the FindSubstring Choreo. A TembooSession object, containing a valid
        set of Temboo credentials, must be supplied.
        """
        super(FindSubstring, self).__init__(temboo_session, '/Library/Utilities/Finding/FindSubstring')


    def new_input_set(self):
        return FindSubstringInputSet()

    def _make_result_set(self, result, path):
        return FindSubstringResultSet(result, path)

    def _make_execution(self, session, exec_id, path):
        return FindSubstringChoreographyExecution(session, exec_id, path)

class FindSubstringInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the FindSubstring
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_CaseSensitive(self, value):
        """
        Set the value of the CaseSensitive input for this Choreo. ((optional, boolean) When set to true, the search will be case-sensitive. Defaults to false indicating a case-insensitive search.)
        """
        super(FindSubstringInputSet, self)._set_input('CaseSensitive', value)
    def set_StartNumber(self, value):
        """
        Set the value of the StartNumber input for this Choreo. ((optional, string) The character position at which to begin the search. Defaults to 1.)
        """
        super(FindSubstringInputSet, self)._set_input('StartNumber', value)
    def set_Substring(self, value):
        """
        Set the value of the Substring input for this Choreo. ((required, string) The sub-string to search within the specified text (searching from left to right).)
        """
        super(FindSubstringInputSet, self)._set_input('Substring', value)
    def set_Text(self, value):
        """
        Set the value of the Text input for this Choreo. ((required, string) The text to search for a sub-string.)
        """
        super(FindSubstringInputSet, self)._set_input('Text', value)

class FindSubstringResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the FindSubstring Choreo.
    The ResultSet object is used to retrieve the results of a Choreo execution.
    """

    def getJSONFromString(self, str):
        return json.loads(str)

    def get_Count(self):
        """
        Retrieve the value for the "Count" output from this Choreo execution. ((integer) The count of sub-strings found.)
        """
        return self._output.get('Count', None)
    def get_Positions(self):
        """
        Retrieve the value for the "Positions" output from this Choreo execution. ((json) The positions of the sub-strings that were found in the search.)
        """
        return self._output.get('Positions', None)

class FindSubstringChoreographyExecution(ChoreographyExecution):

    def _make_result_set(self, response, path):
        return FindSubstringResultSet(response, path)
