001package ca.cdr.api.fhir.tokenization;
002
003import ca.uhn.fhir.rest.api.server.RequestDetails;
004import org.hl7.fhir.instance.model.api.IBase;
005
006/**
007 * This class represents a single request to "de-tokenize" a previously tokenized string.
008 * The request will be processed by the same {@link ITokenizationProvider} that originally
009 * provided the tokenized string.
010 */
011public class DetokenizationRequest {
012
013        private final String myToken;
014        private final IBase myTarget;
015
016        /**
017         * Constructor
018         */
019        public DetokenizationRequest(IBase theTarget, String theToken) {
020                myTarget = theTarget;
021                myToken = theToken;
022        }
023
024        /**
025         * This is the object which will receive the detokenized value. For example, if an Identifier instance was
026         * originally passed to the {@link ITokenizationProvider#tokenize(RequestDetails, TokenizationRequests)} method,
027         * then this will contain an empty Identifier instance. The provider does not need to modify or otherwise
028         * touch this object, but it is provided in case it will be helpful to the de-tokenization algorithm.
029         */
030        public IBase getTarget() {
031                return myTarget;
032        }
033
034        /**
035         * This is the token string which needs to be reversed. In other words, this is the string that was
036         * previously supplied to {@link TokenizationResults#addResult(TokenizationRequest, String)} by the
037         * provider.
038         */
039        public String getToken() {
040                return myToken;
041        }
042}