cdc.mf.checks.atts.text.AbstractTextMustContainOneToken Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cdc-mf-checks Show documentation
The newest version!
package cdc.mf.checks.atts.text;

import cdc.issues.IssueSeverity;
import cdc.issues.checks.CheckContext;
import cdc.issues.checks.CheckResult;
import cdc.issues.checks.SnapshotManager;
import cdc.issues.locations.Location;
import cdc.issues.rules.Rule;
import cdc.mf.checks.IssueDescription;
import cdc.mf.checks.MfAbstractRuleChecker;
import cdc.util.strings.StringUtils;

public abstract class AbstractTextMustContainOneToken extends MfAbstractRuleChecker {
    public static final IssueSeverity SEVERITY = IssueSeverity.MAJOR;
    protected static final String MUST_CONTAIN_ONE_TOKEN = " must contain one token.";

    protected AbstractTextMustContainOneToken(SnapshotManager manager,
                                              Class objectClass,
                                              Rule rule) {
        super(manager,
              objectClass,
              rule);
    }

    protected abstract String getText(O object);

    @Override
    public CheckResult check(CheckContext context,
                             O object,
                             Location location) {
        final String text = getText(object);
        if (!StringUtils.isNullOrEmpty(text)
                && !TextUtils.containsOneToken(text)) {
            final IssueDescription.Builder description = IssueDescription.builder();

            description.header(getHeader(object))
                       .value(text)
                       .violation("does not contain one token");
            int index = 0;
            final int count = TextUtils.getTokensCount(text);
            if (count != 1) {
                index++;
                description.justification(index, "It contains " + count + " tokens.");
            }
            if (TextUtils.containsSpaces(text)) {
                index++;
                description.justification(index, "It contains spaces.");
            }

            add(issue().description(description)
                       .location(location)
                       .build());
            return CheckResult.FAILURE;
        } else {
            return CheckResult.SUCCESS;
        }
    }
}