| /* |
| * Copyright (c) 2013 DataTorrent, Inc. ALL Rights Reserved. |
| * |
| * 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. |
| */ |
| package com.datatorrent.lib.logs; |
| |
| import com.datatorrent.api.annotation.OperatorAnnotation; |
| import com.datatorrent.api.annotation.Stateless; |
| import java.util.HashMap; |
| |
| /** |
| * Splits lines into tokens, and tokens into sub-tokens and emits key,val pairs in a HashMap. |
| * Each token is emitted as a key value pair only if the key is allowed by the specified filter. |
| * <p> |
| * This module is a pass through. Ideal for applications like log |
| * processing where only a few keys are to be processed<br> |
| * <br> |
| * <b>StateFull : No, </b> tokens are processed in current window. <br> |
| * <b>Partitions : Yes, </b> No state dependency in output tokens. <br> |
| * <br> |
| * <b>Ports</b>:<br> |
| * <b>data</b>: expects String<br> |
| * <b>tokens</b>: emits HashMap<String,String><br> |
| * <br> |
| * <b>Properties</b>:<br> |
| * <b>splitby</b>: The characters used to split the line. Default is ";\t "<br> |
| * <b>splittokenby</b>: The characters used to split a token into key,val pair. |
| * Default is "", i.e. tokens are not split, and key is set to token, and val is |
| * null<br> |
| * <b>filterby</b>: Only emit the keys (comma separated) that are in filterby |
| * <br> |
| * </p> |
| * |
| * @displayName Filtered Line Tokenizer Key Value |
| * @category Logs |
| * @tags string, key value |
| * |
| * @since 0.3.3 |
| */ |
| @Stateless |
| @OperatorAnnotation(partitionable=true) |
| public class FilteredLineTokenizerKeyVal extends LineTokenizerKeyVal |
| { |
| HashMap<String, Object> filterBy = new HashMap<String, Object>(4); |
| |
| /** |
| * setter function for filterBy |
| * |
| * @param list |
| * list of keys for subtoken filters |
| */ |
| public void setFilterBy(String[] list) |
| { |
| if (list != null) { |
| for (String s : list) { |
| filterBy.put(s, null); |
| } |
| } |
| } |
| |
| /** |
| * If the key is in the filter, returns true |
| * |
| * @param subtok |
| * @return true if super.validToken (!isEmpty()) and filter has they token |
| */ |
| @Override |
| public boolean validSubTokenKey(String subtok) |
| { |
| return super.validToken(subtok) && filterBy.containsKey(subtok); |
| } |
| } |