TagsProcessor

Description

The TagsProcessor class allows you to extract and process search tags from objects.

Important points

• The search tags can be kept individually or embedded as hash tags inside text. E.g. “This text has #hash_tag that can be used for search.”

Static methods

compressTag

Compress a tag by removing special symbols like spaces, ‘_’ and ‘#’ and converting the tag to lower case. When tags are compressed, they can be matched in search queries.

public static compressTag(tag: string): string

• tag: string - tag to compress.
• returns: string - compressed tag.

compressTagList

Compresses a comma-separated list of tags.

public static compressTagList(tagList: string): string[]

• tagList: string - comma-separated list of tags to compress.
• returns: string[] - list with compressed tags.

compressTags

Compresses a list of tags.

public static compressTags(tags: string[]): string[]

• tagList: string[] - tags to compress.
• returns: string[] - list with normalized tags.

equalTags

Compares two tags using their compressed form.

public static equalTags(tag1: string, tag2: string): boolean

• tag1: string - first tag.
• tag2: string - second tag.
• returns: boolean - true if the tags are equal and false otherwise.

extractHashTags

Extracts hash tags from a text.

public static extractHashTags(text: string): string[]

• text: string - text that contains hash tags
• returns: string[] - list with extracted and compressed tags.

extractHashTagsFromValue

Extracts hash tags from selected fields in an object.

public static extractHashTagsFromValue(obj: any, …searchFields: string[]): string[]

• obj: any - object which contains hash tags.
• searchFields: string[] - list of fields in the objects where to extract tags
• returns: string[] - list of extracted and compressed tags.

normalizeTag

Normalizes a tag by replacing special symbols like ‘_’ and ‘#’ with spaces. When tags are normalized, they are presented in similar shape and form.

public static normalizeTag(tag: string): string

• tag: string - tag to normalize.
• returns: string - normalized tag.

normalizeTagList

Normalizes a comma-separated list of tags.

public static normalizeTagList(tagList: string): string[]

• tagList: string - comma-separated list of tags to normalize.
• returns: string[] - list with normalized tags.

normalizeTags

Normalizes a list of tags.

public static normalizeTags(tags: string[]): string[]

• tags: string[] - tags to normalize.
• returns: string[] - list with normalized tags.