com.github.easydoc.semantics.paramrule.IdParamRule Maven / Gradle / Ivy

Go to download
package com.github.easydoc.semantics.paramrule;

import java.util.List;

import com.github.easydoc.model.Doc;
import com.github.easydoc.model.Model;
import com.github.easydoc.model.criteria.DocSearchCriteria;
import com.github.easydoc.semantics.NegativeValidationResult;
import com.github.easydoc.semantics.PositiveValidationResult;
import com.github.easydoc.semantics.ValidationResult;

/*@@easydoc-start, id=easydoc-parameters, belongs=easydoc-usage, weight=-1000@@
Parameters

id

With this parameter you can define the unique identifier for the doc to reference it
from elsewhere. Primarily, you use it together with belongs parameter to group 
docs and form the doc tree. 



If the id is specified, the HTML anchor to this doc will be generated with this id,
and the doc will be referenceable by adding #id_value to the page address. 



Requirements:



The id you define should be unique across all docs in your code. If it is not, easydoc
will fail.
 
@@easydoc-end@@*/
public class IdParamRule implements ParamRule {

	@Override
	public boolean requiresValue() {
		return true;
	}
	
	@Override
	public ValidationResult validate(final String value, final Doc doc, Model model) {
		List result = model.findDocs(new DocSearchCriteria() {
			@Override
			public boolean satisfies(Doc item) {
				return item != doc && value.equals(item.getParams().get("id"));
			}
		});
		
		if(result.size() > 0) {
			return new NegativeValidationResult(
					String.format(
							"Id '%s' is not unique. Found %d doc(s) with the same id (%s)", 
							value,
							result.size(),
							result.toString()
					)
			);
		}
		
		return PositiveValidationResult.getDefaultInstance();
	}

	@Override
	public void run(String value, Doc doc, Model model, ValidationResult validationResult) {
		doc.setId(value);
	}

}